Intégrer une organisation

Pour intégrer une organisation, vous devez créer un fichier de configuration d'intégration, puis le transmettre à la setup-org commande. Chacune de ces étapes est décrite dans les sections qui suivent.

Pour savoir comment utiliser l'API de gestion afin d'intégrer une organisation, consultez Créer une organisation, un environnement et un hôte virtuel.

Créer un fichier de configuration d'intégration

Cette section inclut un exemple de fichier de configuration pour intégrer une organisation avec setup-org.

Copiez l'exemple suivant et modifiez-le si nécessaire pour votre organisation :

# Specify the IP or DNS name of the Management Server.
IP1=MANAGEMENT_SERVER_IP_ADDRESS

MSIP="$IP1"

# Specify the Edge sys admin credentials.
ADMIN_EMAIL="admin@email.com"
APIGEE_ADMINPW=admin_password  # If omitted, you are prompted for it.

# Specify organization name.
ORG_NAME=myorg  # lowercase only, no spaces, underscores, or periods.

# Specify the organization administrator user.
# Either specify an existing user, or specify the information
# necessary to create a new user.
# Do not use the sys admin as the organization administrator.
#
# Create a new user for the organization administrator.
NEW_USER="y"
# New user information if NEW_USER="y".
USER_NAME=new@user.com
FIRST_NAME=new
LAST_NAME=user
# Org admin password must be at least 8 characters long and contain one uppercase
# letter, one lowercase letter, and one digit or special character
USER_PWD="newUserPword"
ORG_ADMIN=new@user.com
#
# Or, specify an existing user as the organization admin,
# omit USER_NAME, FIRST_NAME, LAST_NAME, USER_PWD.
# NEW_USER="n"
# ORG_ADMIN=existing@user.com

# Specify environment name.
ENV_NAME=prod  # lowercase only

# Specify virtual host information.
VHOST_PORT=9001
VHOST_NAME=default

# If you have a DNS entry for the virtual host.
VHOST_ALIAS=myorg-test.apigee.net

# If you do not have a DNS entry for the virtual host,
# specify the IP and port of each router as a space-separated list:
# VHOST_ALIAS="firstRouterIP:9001 secondRouterIP:9001"

# Optionally configure TLS/SSL for virtual host.
# VHOST_SSL=y     # Set to "y" to enable TLS/SSL on the virtual host.
# KEYSTORE_JAR=   # JAR file containing the cert and private key.
# KEYSTORE_NAME=  # Name of the keystore.
# KEYSTORE_ALIAS= # The key alias.
# KEY_PASSWORD=   # The key password, if it has one.

# Specify the analytics group.
# AXGROUP=axgroup-001 # Default name is axgroup-001.

Notez que :

  • Pour VHOST_ALIAS, si vous disposez déjà d'un enregistrement DNS que vous utiliserez pour accéder à l'hôte virtuel, spécifiez l'alias d'hôte et éventuellement le port, par exemple "myapi.example.com". Si vous ne disposez pas encore d'enregistrement DNS vous pouvez utiliser l'adresse IP du routeur.

    Pour en savoir plus sur la configuration de l'hôte virtuel, consultez Configurer un hôte virtuel.

  • Pour la configuration TLS/SSL, consultez Keystores and Truststores et Configuring TLS access to an API for the cloud privé pour en savoir plus sur la création du fichier JAR, et d'autres aspects de la configuration TLS/SSL.
  • Pour en savoir plus sur la configuration des hôtes virtuels, consultez Configurer l'accès TLS à une API pour le cloud privé.
  • Vous ne pouvez pas créer deux organisations portant le même nom. Dans ce cas, la deuxième création échouera.

Exécuter setup-org

Une fois le fichier de configuration d'intégration créé, transmettez-le au setup-org script pour effectuer le processus d'intégration. Vous devez exécuter le script sur le nœud du serveur de gestion.

Lors de l'intégration d'une organisation, le script setup-org effectue les opérations suivantes :

  • Crée une organisation.
  • Crée un environnement.
  • Crée un hôte virtuel pour l'environnement.
  • Définit l'utilisateur spécifié comme administrateur de l'organisation. Remarques :
    • Vous pouvez utiliser un utilisateur existant ou en créer un pour l'administrateur de l'organisation.
    • L'administrateur de l'organisation ne doit pas être le même que l'administrateur système.
  • Associe l'organisation au pod "gateway". (Il s'agit de la valeur par défaut, qui ne peut pas être modifiée.)
  • Associe l'environnement à tous les processeurs de messages.
  • Active Analytics.

Pour exécuter setup-org:

  1. Installez apigee-provision sur le nœud du serveur de gestion : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-provision install
  2. Exécutez le script setup-org sur le nœud du serveur de gestion et pointez-le vers le fichier de configuration que vous avez créé dans Créer un fichier de configuration d'intégration : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile

    Le fichier de configuration doit être lisible par l'utilisateur "apigee".

  3. Vérifiez que vous avez bien intégré une organisation. Pour ce faire, vous pouvez vous connecter à la nouvelle interface utilisateur Edge en demandant l'URL suivante dans un navigateur : 
    http://IP_address:3001

    Où IP_address est l'adresse IP du serveur sur lequel vous avez installé la nouvelle interface utilisateur Edge.

    Pour connaître les étapes de validation supplémentaires, consultez Vérifier l'intégration.

  4. Créez votre premier proxy.

Vérifier l'intégration

Une fois l'intégration terminée, vérifiez l'état du système en exécutant les commandes curl suivantes sur le nœud du serveur de gestion :

  1. Vérifiez l'état de l'utilisateur et de l'organisation sur le serveur de gestion en exécutant les commandes suivantes : 
    curl -u adminEmail:admin_passwd http://localhost:8080/v1/users
curl -u adminEmail:admin_passwd http://localhost:8080/v1/organizations
curl -u adminEmail:admin_passwd http://localhost:8080/v1/organizations/org_name/deployments
  2. Vérifiez Analytics en exécutant la commande suivante : 
    curl -u adminEmail:admin_password http://localhost:8080/v1/organizations/org_name/environments/env_name/provisioning/axstatus
  3. Vérifiez l'état de la base de données PostgreSQL en exécutant les commandes suivantes sur le nœud 2 (comme indiqué dans les topologies d'installation) : 
    psql -h /opt/apigee/var/run/apigee-postgresql -U apigee apigee

    À l'invite de commande, saisissez la commande suivante pour afficher le tableau Analytics de votre organisation :

    \d analytics."org_name.env_name.fact"

    Utilisez la commande suivante pour quitter psql :

    \q
  4. Accédez à la nouvelle interface utilisateur Edge à l'aide d'un navigateur Web. N'oubliez pas que vous avez déjà noté l' URL de la console de gestion à la fin de l'installation.
    1. Lancez le navigateur de votre choix et saisissez l'URL de la nouvelle interface utilisateur Edge. Elle ressemble à ceci, où l'adresse IP correspond au nœud 1 (comme indiqué dans les topologies d'installation) ou au nœud sur lequel vous avez installé la nouvelle interface utilisateur Edge pour d'autres configurations : 
      http://192.168.56.111:3001

      3001 est le numéro de port par défaut utilisé par la nouvelle interface utilisateur Edge.

      Si vous démarrez le navigateur directement sur le serveur hébergeant la nouvelle interface utilisateur Edge, vous pouvez utiliser une URL au format suivant : 

      http://localhost:3001
    2. Sur la page de connexion à la console, spécifiez le nom d'utilisateur et le mot de passe de l'administrateur système Apigee.
  5. Inscrivez-vous pour créer un compte utilisateur Apigee et utilisez les nouvelles identifiants pour vous connecter. Sur la page de connexion à la console, cliquez sur le bouton Se connecter.

    Le navigateur redirige vers http://192.168.56.111:3001/edge et ouvre un tableau de bord qui vous permet de configurer l'organisation que vous avez créée (si vous vous êtes connecté à l'aide des identifiants d'administrateur Apigee).

Créer votre premier proxy

Une fois que vous avez intégré une organisation et vérifié que le processus d'intégration s'est déroulé correctement, vous pouvez créer votre premier proxy. Pour en savoir plus, consultez Créer votre premier proxy d'API.

Voici d'autres ressources qui peuvent vous être utiles :