Installation BaaS de l'API

Edge for Private Cloud v. 4.17.01

Présentation de l'installation

Après avoir installé l'utilitaire apigee-setup d'Edge sur un nœud, utilisez-le pour installer un ou plusieurs composants BaaS sur le nœud.

L'utilitaire apigee-setup se présente sous la forme suivante :

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Transmettez un fichier de configuration à l'utilitaire apigee-setup contenant les informations sur l'installation. Si des informations requises sont manquantes dans le fichier de configuration, l'utilitaire apigee-setup vous invite à les saisir sur la ligne de commande.

La seule exigence est que le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".

Par exemple, utilisez la commande suivante pour installer la pile API BaaS :

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p b -f myConfig

Spécifier les composants à installer

L'utilitaire Apigee setup.sh est compatible avec plusieurs options d'installation des composants API BaaS. Les instructions ci-dessous utilisent les options autonomes (c, e, b et p), mais vous pouvez utiliser différentes options en fonction de la configuration de votre nœud :

Option

Description

e

Installez uniquement ElasticSearch.

b

Installez uniquement la pile API BaaS, qui installe également Tomcat.

p

Installez uniquement le portail API BaaS, qui installe également le routeur Nginx à utiliser comme serveur Web.

c

Installez uniquement Cassandra.

eb

Installez ElasticSearch, la pile API BaaS et Tomcat sur le nœud.

ebp

Installez ElasticSearch, le portail API BaaS, la pile API BaaS et Tomcat, mais pas Cassandra. Le portail est si léger qu'aucune ressource supplémentaire n'est nécessaire.

asa

Installez tous les composants API BaaS sur un seul nœud (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat). Utilisez cette option uniquement pour le développement et les tests, et non pour la production.

Créer un fichier de configuration

Le fichier de configuration contient toutes les informations nécessaires pour installer API BaaS. Vous pouvez souvent utiliser le même fichier de configuration pour installer tous les composants d'une installation BaaS.

Chaque topologie d'installation décrite ci-dessous présente un exemple de fichier de configuration pour cette topologie. Pour obtenir une documentation de référence complète sur le fichier de configuration, consultez la documentation de référence sur le fichier de configuration BaaS.

Installer API BaaS sur un seul nœud

Vous trouverez ci-dessous le fichier de configuration permettant d'installer API BaaS sur un seul nœud. Modifiez ce fichier si nécessaire pour votre configuration. Pour obtenir une documentation de référence complète sur le fichier de configuration, consultez la documentation de référence sur le fichier de configuration BaaS. 

IP1=192.168.56.101   # IP address of single node

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Define the API BaaS administrator account.  
AS_ADMIN="superuser"    # User name - default is "superuser".
AS_ADMIN_EMAIL=stackAdmin@email.com
AS_PASSWD=stackAdminPWord

# Because you are installing Cassandra,
# specify Cassandra data center and rack suffix.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1"

# Specify the Cassandra region.
REGION=dc-1

# Cassandra uname/pword.
# Even if Cassandra authentication is disabled,
# you must still pass values for these properties.
CASS_USERNAME=cassandra    # Default value
CASS_PASSWORD=cassandra    # Default value

# Specify Cassandra data center name.
BAAS_CASS_LOCALDC=dc-1

# For a single data center, specify the same value as BAAS_CASS_LOCALDC.
BAAS_CASS_DC_LIST=dc-1

# Replication is in the form "dataCenterName:#CassandraNodes". 
# For dc-1 with one Cassandra node, it is dc-1:1.
BAAS_CASS_REPLICATION=dc-1:1

# Defines the initial contact points for members of the BaaS cluster. 
# For a single node install, specify the IP address of the node. 
BAAS_CLUSTER_SEEDS="dc-1:$IP1"

# Single ElasticSearch IP.
ES_HOSTS="$IP1"

# API BaaS Stack information.
# Default cluster name is "apigee_baas"
BAAS_USERGRID_CLUSTERNAME="apigee_baas" 

# IP/DNS and port 8080 of a single Stack node.
BAAS_USERGRID_URL="http://$IP1:8080"

# URL and port of the BaaS Portal node.  
BAAS_PORTAL_URL="http://$IP1:9000"

# Portal port. Default value is 9000.
BAAS_PORTAL_LISTEN_PORT=9000

# SMTP information. BaaS requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y

Pour installer API BaaS sur son propre nœud :

  1. Installez l'utilitaire Edge apigee-setup sur le nœud à l'aide de la procédure Internet ou non Internet. Pour en savoir plus, consultez Installer l'utilitaire apigee-setup d'Edge.
  2. À l'invite de commande, exécutez le script de configuration :
    > /opt/apigee/apigee-setup/bin/setup.sh -p asa -f configFile

    L'option "-p asa" spécifie d'installer tous les composants API BaaS sur un seul nœud (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat).
    Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".
  3. Comme vous avez installé Elasticsearch sur un nœud autonome, ajustez l'option de mémoire par défaut pour augmenter la mémoire allouée à Elasticsearch de 4 Go à 6 Go :
    1. Ouvrez /opt/apigee/customer/application/elasticsearch.properties dans un éditeur. Si ce fichier n'existe pas, créez-le.
    2. Définissez la propriété setenv_elasticsearch_max_mem_size sur 6g (la valeur par défaut est 4g) :
      setenv_elasticsearch_max_mem_size=6g
    3. Enregistrez le fichier.
    4. Exécutez la commande suivante :
      > /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch restart
  4. Intégrez une organisation comme décrit ci-dessous dans Intégrer une nouvelle organisation.

La configuration se termine correctement sur le nœud.

Installer API BaaS sur 7 ou 10 nœuds

La procédure d'installation d'une version à 7 ou 10 nœuds d'API BaaS est très similaire. La seule différence est que pour un :

  • Dans une installation à 10 nœuds, vous installez les trois composants ElasticSearch et les trois composants de la pile API BaaS sur des nœuds distincts, soit un total de six nœuds. Il s'agit de la configuration recommandée pour des performances optimales, car Elasticsearch nécessite une grande quantité d'E/S de disque et de mémoire.
  • Dans une installation à sept nœuds, vous installez les trois composants Elasticsearch et les trois composants de la pile API BaaS sur les mêmes nœuds, pour un total de trois nœuds.

Pour les versions à 7 et 10 nœuds d'API BaaS, vous devez vous connecter à un cluster Cassandra. Si vous avez déjà installé Edge, vous pouvez vous connecter à son cluster Cassandra, ce qui signifie que vous n'avez pas besoin d'installer Cassandra dans le cadre de l'installation d'API BaaS.

Vous trouverez ci-dessous un exemple de fichier de configuration silencieuse pour une installation d'API BaaS à 10 nœuds. Si vous installez les composants de la pile ElasticSearch et API BaaS sur les trois mêmes nœuds, modifiez le fichier de sorte que :

  • IP1 et IP4 sont définies sur la même adresse IP
  • IP2 et IP5 sont définies sur la même adresse IP
  • IP3 et IP6 sont définis sur la même adresse IP

Modifiez ce fichier si nécessaire pour votre configuration. Pour obtenir une documentation de référence complète sur le fichier de configuration, consultez la documentation de référence sur le fichier de configuration BaaS. 

# Specify IP address or DNS name of node.
IP1=192.168.1.1   # ElasticSearch
IP2=192.168.1.2   # ElasticSearch
IP3=192.168.1.3   # ElasticSearch
IP4=192.168.1.4   # API BaaS Stack
IP5=192.168.1.5   # API BaaS Stack
IP6=192.168.1.6   # API BaaS Stack
IP7=192.168.1.7   # API BaaS Portal
IP8=192.168.1.8   # Cassandra (shared with Edge or standalone)
IP9=192.168.1.9   # Cassandra (shared with Edge or standalone)
IP10=192.168.1.10  # Cassandra (shared with Edge or standalone)

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Define the API BaaS administrator account.  
AS_ADMIN="superuser"    # User name - default is "superuser".
AS_ADMIN_EMAIL=stackAdmin@email.com
AS_PASSWD=stackAdminPWord

# Only if you are installing Cassandra.
# Specify Cassandra data center and rack suffix.
# Must use IP addresses for CASS_HOSTS, not DNS names.
# CASS_HOSTS="$IP8:1,1 $IP9:1,1 $IP10:1,1"

# If connecting to existing Cassandra nodes, 
# specify Cassandra IPs.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP8 $IP9 $IP10"

# Specify the Cassandra region.
REGION=dc-1

# Cassandra uname/pword.
# Even if Cassandra authentication is disabled,
# you must still pass values for these properties.
CASS_USERNAME=cassandra    # Default value
CASS_PASSWORD=cassandra    # Default value

# Specify BaaS Cassandra connection information.
# Specify the data center name.
BAAS_CASS_LOCALDC=dc-1    # Default is dc-1.

# For a single data center, specify the same value as BAAS_CASS_LOCALDC.
BAAS_CASS_DC_LIST=dc-1

# Replication is in the form "dataCenterName:#CassandraNodes". 
# For example, for dc-1 with three Cassandra nodes, it is dc-1:3.
BAAS_CASS_REPLICATION=dc-1:3

# Defines the initial contact points for members of the BaaS cluster. 
# Specify the IP address of no more than two Stack nodes. 
BAAS_CLUSTER_SEEDS="dc-1:$IP4,dc-1:$IP5"

# ElasticSearch IPs or DNS names, separated by spaces.
ES_HOSTS="$IP1 $IP2 $IP3"

# API BaaS Stack information.
# Default cluster name is "apigee_baas"
BAAS_USERGRID_CLUSTERNAME="apigee_baas" 

# URL and port of the load balancer for the API BaaS Stack nodes, 
# or IP/DNS and port 8080 of a single Stack node with no load balancer.
BAAS_USERGRID_URL=http://myloadbalancer:8443

# API BaaS Portal information.
# URL and port number of load balancer, if there is one in front of the Portal,
# or the URL and port of the Portal node.  
BAAS_PORTAL_URL="http://$IP7:9000"

# Portal port. Default value is 9000.
BAAS_PORTAL_LISTEN_PORT=9000 

# SMTP information. BaaS requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y

Facultatif : Installer Cassandra : machines 8, 9 et 10

Vous pouvez connecter API BaaS au même cluster Cassandra que celui utilisé par Edge. Si vous n'avez pas installé Edge, vous pouvez éventuellement installer Cassandra pour l'utiliser avec API BaaS.

Le cluster Cassandra peut utiliser l'authentification, ou l'authentification Cassandra peut être désactivée. Pour en savoir plus, consultez Activer l'authentification Cassandra.

  1. Installez l'utilitaire Edge apigee-setup sur le nœud à l'aide de la procédure Internet ou non Internet. Pour en savoir plus, consultez Installer l'utilitaire apigee-setup d'Edge.
  2. À l'invite de commande, exécutez le script de configuration :
    > /opt/apigee/apigee-setup/bin/setup.sh -p c -f configFile

    L'option "-p c" spécifie l'installation de Cassandra.
    Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".

La configuration termine la configuration du datastore sur le nœud.

Notez que JMX est activé par défaut pour Cassandra. L'accès à distance JMX à Cassandra ne nécessite pas de mot de passe. Vous pouvez configurer Cassandra pour qu'il utilise l'authentification pour JMX. Pour en savoir plus, consultez Surveiller.

Configurer un job Cron Cassandra

Si vous devez installer Cassandra, configurez un job Cron qui utilise nodetool pour vider les verrous toutes les heures sur chaque nœud Cassandra.

Si vous disposez de plusieurs nœuds Cassandra, décalez le job Cron de cinq minutes sur chaque serveur afin que tous les nœuds ne soient pas vidés en même temps.

Le job Cron doit exécuter la commande suivante :

/opt/apigee/apigee-cassandra/bin/nodetool -h IP_address flush Apigee_Baas_Locks

où IP_address est l'adresse IP du nœud Cassandra.

Installer ElasticSearch : machines 1, 2 et 3

Pour installer ElasticSearch sur son propre nœud :

  1. Installez l'utilitaire apigee-setup d'Edge sur le nœud à l'aide de la procédure Internet ou non Internet. Pour en savoir plus, consultez Installer l'utilitaire apigee-setup d'Edge.
  2. Dans l'invite de commande, exécutez le script de configuration :
    > /opt/apigee/apigee-setup/bin/setup.sh -p e -f configFile

    L'option "-p e" spécifie l'installation d'ElasticSearch.
    Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".
  3. (Facultatif) Si vous installez ElasticSearch sur un nœud autonome, ce qui signifie qu'il n'est pas installé avec la pile API BaaS, ajustez l'option de mémoire par défaut pour augmenter l'allocation de mémoire pour ElasticSearch de 4 Go à 6 Go :
    1. Ouvrez /opt/apigee/customer/application/elasticsearch.properties dans un éditeur. Si ce fichier n'existe pas, créez-le.
    2. Définissez la propriété setenv_elasticsearch_max_mem_size sur 6g (la valeur par défaut est 4g) :
      setenv_elasticsearch_max_mem_size=6g
    3. Enregistrez le fichier.
    4. Exécutez la commande suivante :
      > /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch restart

La configuration se termine correctement sur le nœud.

Installer la pile API BaaS : machines 4, 5 et 6

Pour installer la pile API BaaS sur son propre nœud :

  1. Installez l'utilitaire apigee-setup d'Edge sur le nœud à l'aide de la procédure Internet ou non Internet. Pour en savoir plus, consultez Installer l'utilitaire apigee-setup d'Edge.
  2. À l'invite de commande, exécutez le script de configuration :
    > /opt/apigee/apigee-setup/bin/setup.sh -p b -f configFile

    L'option "-p b" spécifie l'installation de la pile API BaaS.
    Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".

Une fois que le programme d'installation a récupéré les identifiants d'administrateur appropriés, il installe Tomcat, crée des espaces de clés API BaaS et configure la pile API BaaS sur le serveur. SMTP est également configuré pour permettre à l'interface utilisateur d'envoyer des e-mails de confirmation de mot de passe.

Installer le portail API BaaS : machine 7

Pour installer le portail API BaaS :

  1. Installez l'utilitaire apigee-setup d'Edge sur le nœud à l'aide de la procédure Internet ou non Internet. Pour en savoir plus, consultez Installer l'utilitaire apigee-setup d'Edge.
  2. À l'invite de commande, exécutez le script de configuration :
    > /opt/apigee/apigee-setup/bin/setup.sh -p p -f configFile

    L'option "-p p" spécifie l'installation du portail API BaaS.
    Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".

    Le programme d'installation démarre le serveur Web Nginx, puis termine la configuration du portail API BaaS.
  3. L'étape suivante dépend de votre installation.
    1. Si vous disposez d'un équilibreur de charge devant les nœuds Portal ou Stack, la section suivante explique comment configurer API BaaS pour les équilibreurs de charge.
    2. Si vous ne disposez pas d'un équilibreur de charge devant les nœuds Portalor Stack, intégrez une organisation comme décrit ci-dessous dans la section Intégrer une nouvelle organisation.

Notez l'URL du portail API BaaS. Il s'agit de l'URL que vous saisissez dans un navigateur pour accéder à l'interface utilisateur du portail API BaaS.

Configurer des nœuds API BaaS pour un équilibreur de charge Stack ou Portal

Si vous incluez un équilibreur de charge devant les nœuds Stack ou Portal, vous devez configurer les nœuds avec l'URL correcte de l'équilibreur de charge. Par exemple, les nœuds Stack ont besoin de ces informations dans les cas suivants :

  • Inclure une URL dans les réponses aux requêtes de l'API BaaS.
  • Ajouter des liens dans les modèles d'e-mails lors de la réinitialisation d'un mot de passe ou de l'envoi d'autres notifications.
  • Rediriger les utilisateurs vers des pages spécifiques du portail.

Si vous utilisez un équilibreur de charge devant les nœuds Stack, définissez la propriété suivante dans /opt/apigee/customer/application/usergrid.properties : 

usergrid-deployment_usergrid.api.url.base=http://localhost:8080

Remplacez http://localhost:8080 par l'URL de l'équilibreur de charge. Si l'équilibreur de charge est configuré pour utiliser TLS, utilisez le protocole HTTPS. Vous ne devez inclure le port que si vous utilisez un port non standard, c'est-à-dire un port autre que le port 80 pour HTTP et le port 443 pour HTTPS.

Vous devez également définir la propriété suivante dans /opt/apigee/customer/application/portal.properties si vous utilisez un équilibreur de charge devant les nœuds Stack :

baas.portal.config.overrideUrl=http://localhost:8080

Remplacez http://localhost:8080 par l'URL de l'équilibreur de charge de la pile.

Si vous utilisez un équilibreur de charge devant le nœud du portail, définissez les propriétés suivantes dans usergrid.properties : 

usergrid-deployment_portal.url=http://localhost:9000

Remplacez http://localhost:9000 par l'URL de l'équilibreur de charge. Si l'équilibreur de charge est configuré pour utiliser TLS, utilisez le protocole HTTPS. Vous ne devez inclure le port que si vous utilisez un port non standard, c'est-à-dire un port autre que le port 80 pour HTTP et le port 443 pour HTTPS.

Après avoir modifié usergrid.properties et portal.properties :

  1. Configurez le nœud Stack :
    > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid configure
  2. Redémarrez la pile BaaS :
    > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid restart

    Remarque : Lorsque vous redémarrez des nœuds de la pile BaaS, redémarrez-les dans l'ordre dans lequel ils sont listés dans BAAS_CLUSTER_SEEDS. BAAS_CLUSTER_SEEDS liste au maximum deux des nœuds de la pile. Après avoir redémarré ces deux nœuds dans l'ordre, vous pouvez redémarrer les nœuds restants dans n'importe quel ordre.

  3. Si vous avez modifié portal.properties, configurez le nœud du portail :
    > /opt/apigee/apigee-service/bin/apigee-service baas-portal configure
  4. Redémarrez le portail BaaS :
    > /opt/apigee/apigee-service/bin/apigee-service baas-portal restart

Intégrer une nouvelle organisation

L'intégration est le processus de création d'une organisation et d'un administrateur de l'organisation. Après avoir créé l'organisation et l'administrateur de l'organisation, vous pouvez vous connecter à l'interface utilisateur du portail API BaaS et envoyer des requêtes à l'API REST API BaaS.

Lorsque vous créez une organisation, l'adresse e-mail de l'administrateur de l'organisation :

  • Elle doit être différente de l'adresse e-mail de l'administrateur système.
  • Il doit être unique parmi toutes les autres organisations. Autrement dit, vous ne pouvez pas créer deux organisations avec la même adresse e-mail pour l'administrateur de l'organisation. Toutefois, après avoir créé l'organisation, vous pouvez ajouter des administrateurs supplémentaires qui peuvent être dupliqués dans plusieurs organisations.

Pour effectuer l'intégration, utilisez le script Python create_org_and_user.py. Si vous appelez ce script sans argument de ligne de commande, il vous invite à saisir toutes les informations :

> python create_org_and_user.py

Vous pouvez également transmettre une ou plusieurs options en tant qu'argument de ligne de commande. Vous êtes invité à fournir les informations que vous omettez dans la ligne de commande :

> python create_org_and_user.py -o '<org name>'
> python create_org_and_user.py -o '<org name>' -a '<new admin email>' -p '<new admin password>'

Pour créer une organisation :

  1. Accédez au répertoire /opt/apigee/baas-usergrid/bin.
  2. Appelez le script Python create_org_and_user.py.
    Vous êtes invité à saisir le nom d'utilisateur et le mot de passe de l'administrateur système BaaS afin que seul un administrateur système puisse l'exécuter.
  3. Connectez-vous au portail API BaaS dans un navigateur Web à l'aide de l'URL que vous avez notée à la fin de l'installation de l'URL du portail API BaaS. Pour accéder au portail, saisissez l'URL du portail API BaaS au format suivant :
    http://{portalExternalIP}:9000/

    Remarque : L'adresse IP est l'adresse IP externe/le nom d'hôte de la machine du portail. Assurez-vous que ce port est ouvert.
  4. Lorsque l'écran de connexion au portail s'affiche, vous pouvez :
    • Connectez-vous à l'aide du nom d'utilisateur et du mot de passe de l'administrateur de l'organisation.
    • Connectez-vous à l'aide du nom d'utilisateur et du mot de passe de l'administrateur système.

Accéder à l'API REST API BaaS

Pour accéder à l'API REST API BaaS, utilisez une URL au format suivant :

https://{loadBalancerIP}:8080/{your-org}/{your-app}

Dans un environnement de développement, vous pouvez installer tous les composants API BaaS sur un seul nœud, ce qui signifie que vous disposez d'une seule pile API BaaS. Vous pouvez également disposer d'un petit environnement avec un seul nœud de pile API BaaS et aucun équilibreur de charge. Dans ces types d'environnements, vous pouvez effectuer des appels d'API directement vers le nœud de la pile API BaaS :

curl -v "http://portalExternalIP:8080/status"

Pour en savoir plus sur la prise en main du portail API BaaS, consultez la documentation Apigee à l'adresse suivante : http://apigee.com/docs/content/build-apps-home.