Installation BaaS de l'API

Edge pour Private Cloud v4.18.01

Présentation de l'installation

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

L'utilitaire apigee-setup a au format suivant:

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

Transmettez un fichier de configuration à l'utilitaire apigee-setup qui contient le des informations sur l'installation. Si le fichier de configuration ne contient pas les informations, la configuration apigee-setup vous invite à le saisir dans la ligne de commande.

La seule condition requise est que le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.

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

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

Spécifier les composants à installer

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

Option

Description

e

Installez ElasticSearch uniquement.

b

Installer uniquement la pile API BaaS, qui installe également Tomcat

p

Installer uniquement le portail BaaS de l'API, qui installe également le routeur Nginx pour l'utiliser comme Google Cloud.

c

Installez Cassandra uniquement.

eb

Installez ElasticSearch, API BaaS Stack 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 pour cela.

Asa

Installer tous les composants BaaS de l'API sur un seul nœud (Cassandra, Elasticsearch, API BaaS) Stack, API BaaS Portal, Tomcat). N'utilisez cette option que pour le développement et les tests, et non pour pour la production.

Créer un fichier de configuration

Le fichier de configuration contient toutes les informations nécessaires à l'installation de l'API BaaS. Vous pouvez utilisent souvent 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 Pour obtenir une référence complète sur le fichier de configuration, consultez la documentation de référence sur le fichier de configuration BaaS.

Installer l'API BaaS sur un seul nœud

Vous trouverez ci-dessous le fichier de configuration permettant d'installer l'API BaaS sur un seul nœud. Modifier ce fichier en tant que nécessaires à votre configuration. Pour en savoir plus sur le fichier de configuration, consultez 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
SMTPMAILFROM="My Company <myco@company.com>"

Pour installer l'API BaaS sur son propre nœud:

  1. Installez l'utilitaire Edge apigee-setup sur le nœud à l'aide du avec ou sans Internet. Consultez la section Installer l'utilitaire de configuration Edge apigee pour plus encore.
  2. Dans l'invite de commande, exécutez le script de configuration:
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p asa -f configFile

    L'option "-p asa" indique d'installer tous les composants de l'API BaaS sur un seul nœud. (Cassandra, Elasticsearch, pile API BaaS, portail API BaaS, Tomcat)
    Le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.
  3. Comme vous avez installé ElasticSearch sur un nœud autonome, ajustez la mémoire par défaut pour augmenter la mémoire allouée à ElasticSearch de 4 Go à 6 Go: <ph type="x-smartling-placeholder">
      </ph>
    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 à 6g (la valeur par défaut est 4g):
      setenv_elasticsearch_max_mem_size=6g
    3. Enregistrez le fichier.
    4. Exécutez la commande suivante:
      &gt; /opt/apigee/apigee-service/bin/apigee-service redémarrer apigee-elasticsearch
  4. Intégrez une organisation comme décrit ci-dessous dans la section Intégrer une nouvelle organisation.

La configuration aboutit sur le nœud.

Installer l'API BaaS sur 7 ou 10 nœuds

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

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

Pour les versions d'API BaaS à 7 et 10 nœuds, 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 vous devez installer Cassandra dans le cadre de l'installation de l'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 ElasticSearch et les composants de la pile BaaS de l'API sur les trois mêmes nœuds, modifiez le fichier comme suit:

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

Modifiez ce fichier selon vos besoins. Pour en savoir plus sur de configuration, consultez la section BaaS Documentation de référence du fichier de configuration 

# 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
SMTPMAILFROM="My Company <myco@company.com>"

Facultatif - Installer Cassandra: Machine 8, 9 et 10

Vous pouvez connecter une 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 une utilisation par API BaaS.

Le cluster Cassandra peut utiliser l'authentification, ou l'authentification Cassandra peut être désactivée. Voir Activer l'authentification Cassandra pour plus encore.

  1. Installez l'utilitaire Edge apigee-setup sur le nœud à l'aide du sur Internet ou hors Internet. Consultez la section Installer l'utilitaire de configuration Edge apigee pour plus encore.
  2. Dans l'invite de commande, exécutez le script de configuration:
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p c -f configFile

    L'option "-p c" indique d'installer Cassandra.
    Le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.

La configuration aboutit à 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 fonctionne pas Exiger un mot de passe. Vous pouvez configurer Cassandra pour utiliser l'authentification pour JMX. Pour en savoir plus, consultez Surveiller

Configurer une tâche Cron Cassandra

Si vous devez installer Cassandra, configurez une tâche Cron qui utilise nodetool pour vider les données en vue de l'exécution des verrous toutes les heures. sur chaque nœud Cassandra.

Si vous disposez de plusieurs nœuds Cassandra, décalez la tâche Cron sur chaque serveur de cinq minutes pour qu'elle que tous les nœuds ne sont pas vidés en même temps.

La tâche 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.

Installez ElasticSearch: Machines 1, 2 et 3

<ph type="x-smartling-placeholder">

Pour installer ElasticSearch sur son propre nœud:

  1. Installer l'utilitaire Edge de configuration Apigee sur le nœud via Internet ou non procédure. Voir Installer Edge apigee-setup utilitaire.
  2. Dans l'invite de commande, exécutez le script de configuration:
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p e -f configFile

    L'option "-p e" indique d'installer ElasticSearch.
    Le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.
  3. (Facultatif) Si vous installez ElasticSearch sur un nœud autonome, ce qui signifie qu'il n'est pas installé avec la pile d'API BaaS, puis ajustez l'option de mémoire par défaut pour augmenter la mémoire allouée ElasticSearch de 4 Go à 6 Go: <ph type="x-smartling-placeholder">
      </ph>
    1. Ouvrez /opt/apigee/customer/application/elasticsearch.properties. dans un éditeur. Si ce fichier n'existe pas, créez-le.
    2. Définissez la valeur 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:
      &gt; /opt/apigee/apigee-service/bin/apigee-service redémarrer apigee-elasticsearch

La configuration aboutit sur le nœud.

Installez la pile d'API BaaS: Machines 4, 5 et 6

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

  1. Installer l'utilitaire Edge de configuration Apigee sur le nœud via Internet ou non procédure. Voir Installer Edge apigee-setup utilitaire.
  2. Dans l'invite de commande, exécutez le script de configuration:
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p b -f configFile

    L'option "-p b" indique d'installer la pile d'API BaaS.
    Le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.

Une fois que le programme d'installation a récupéré les bons identifiants d'administrateur, il installe Tomcat, crée l'API des espaces de clés BaaS et configure la pile d'API BaaS sur le serveur. SMTP est également configuré pour autoriser l'UI 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. Installer l'utilitaire Edge de configuration Apigee sur le nœud via Internet ou non procédure. Voir Installer Edge apigee-setup utilitaire.
  2. Dans l'invite de commande, exécutez le script de configuration:
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p p -f configFile

    L'option "-p p" indique d'installer le portail API BaaS.
    Le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.

    Le programme d'installation démarre le serveur Web Nginx, puis termine le portail BaaS de l'API. configuration.
  3. L'étape suivante dépend de votre installation.
    1. Si vous avez un équilibreur de charge devant les nœuds de la pile Portalor, la section suivante explique comment configurer une API BaaS pour les équilibreurs de charge.
    2. Si vous n'avez pas d'équilibreur de charge devant les nœuds de la pile Portalor, intégrez une organisation, comme décrit ci-dessous dans la section Intégration 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 à Interface utilisateur du portail API BaaS

Configurer Nœuds BaaS d'API pour un équilibreur de charge de pile ou de portail

Si vous incluez un équilibreur de charge devant les nœuds de la pile ou du portail, vous devez configurer les nœuds avec l'URL correcte de l'équilibreur de charge. Par exemple, les nœuds Stack exigent informations lorsque:

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

Si vous utilisez un équilibreur de charge devant les nœuds de la pile, 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 du chargement de votre équilibreur de charge. Si l'équilibreur de charge est configuré pour utiliser TLS, utilisez le protocole HTTPS. Vous uniquement Nécessité d'inclure le port si vous utilisez un port non standard, c'est-à-dire 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 utilisez un équilibreur de charge devant les nœuds de la pile:

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

Remplacez http://localhost:8080 par l'URL du pour la pile.

Si vous utilisez un équilibreur de charge devant le nœud de 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 du à un équilibreur de charge HTTP(S) externe global. Si l'équilibreur de charge est configuré pour utiliser TLS, utilisez le protocole HTTPS. Toi ne devez inclure le port que si vous utilisez un port non standard (c'est-à-dire autre chose que port 80 pour HTTP et port 443 pour HTTPS.

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

  1. Configurez le nœud de pile:
    &gt; /opt/apigee/apigee-service/bin/apigee-service configurer baas-usergrid
  2. Redémarrez la pile BaaS:
    &gt; /opt/apigee/apigee-service/bin/apigee-service redémarrage baas-usergrid

    Remarque:Lorsque vous redémarrez des nœuds de pile BaaS, redémarrez-les dans le même ordre qu'ils sont répertoriés dans BAAS_CLUSTER_SEEDS. BAAS_CLUSTER_SEEDS n'affiche pas plus de deux des les 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 les nœuds dans n'importe quel ordre.

  3. Si vous avez modifié portal.properties, configurez le nœud du portail ?
    &gt; /opt/apigee/apigee-service/bin/apigee-service configurer le portail baas-portal
  4. Redémarrez le portail BaaS:
    &gt; /opt/apigee/apigee-service/bin/apigee-service redémarrage du portail baas-portal

Intégration d'une nouvelle organisation

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

Lorsque vous créez une entreprise, 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.
  • 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. Cependant, après avoir créé vous pouvez ajouter des administrateurs supplémentaires qui seront dupliqués dans plusieurs pour les entreprises.

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 demandera toutes les informations:

> python create_org_and_user.py

Vous pouvez également transmettre tout ou partie des options en tant qu'argument de ligne de commande. Vous êtes invité à saisir toute information 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. Remplacez le répertoire par /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 système administrateur peut l'exécuter.
  3. Connectez-vous au portail BaaS de l'API dans un navigateur Web à l'aide de l'URL que vous avez notée à la fin de la Installation de l'URL du portail d'API BaaS Pour accéder au portail, saisissez l'URL du portail BaaS de l'API dans au format suivant:
    http://{portalExternalIP}:9000/

    Remarque: L'adresse IP correspond à l'adresse IP externe ou au 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: <ph type="x-smartling-placeholder">
      </ph>
    • 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 BaaS REST

Pour accéder à l'API REST 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 d'API BaaS. Ou bien, vous pourriez avoir un petit environnement avec un seul Nœud de pile BaaS d'API et aucun équilibreur de charge. Dans ces types d'environnements, vous pouvez effectuer des appels d'API directement au nœud de la pile BaaS de l'API:

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

Pour plus d'informations sur le portail API BaaS, consultez la documentation Apigee à l'adresse suivante: http://apigee.com/docs/content/build-apps-home.