Étape 3 : Créer un groupe d'environnements

Vous consultez actuellement la version 1.14 de la documentation d'Apigee hybrid. Pour en savoir plus, consultez Versions compatibles.

Version 1.14 

   Versions prises en charge :

• v1.16 (la plus récente)                        
• v1.15                         
• v1.14                        
• Liste des versions prises en charge

   Versions non compatibles :

• v1.13                         
• v1.12
• v1.11                         
• v1.10
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

Lors de cette étape, vous allez créer un environnement et un groupe d'environnements.

Dans Apigee, les proxys d'API sont déployés dans des environnements, qui fournissent des contextes isolés pour vos proxys. Les environnements sont organisés en groupes d'environnements qui fournissent des noms d'hôte pour tous les proxys déployés dans les environnements du groupe. Vous devez disposer d'au moins un environnement et d'au moins un groupe d'environnements. Pour en savoir plus, consultez la page À propos des environnements et des groupes d'environnements.

Créez un environnement

Créez l'environnement avant de créer le groupe d'environnements. Vous pouvez créer un environnement à l'aide de l'interface utilisateur d'Apigee ou de l'API. Afin de vous familiariser avec l'UI, vous pouvez l'utiliser pour suivre ces étapes.

Interface utilisateur d'Apigee

Pour créer un environnement dans l'UI Apigee :

1. Dans l'interface utilisateur Apigee, accédez à Gestion > Environnements.

   Accéder à la page Environnements

2. Dans le volet Environnements, cliquez sur + Créer un environnement.
3. Dans le volet Créer un environnement, saisissez les informations suivantes :

   • Nom : nom de l'environnement programmatique. Une fois le nom créé, il ne peut plus être modifié.

     Le nom doit contenir entre 2 et 32 caractères, qui peuvent être des lettres minuscules, des chiffres ou des traits d'union. Le nom doit commencer par une lettre et ne peut pas se terminer par un trait d'union. Le nom doit être différent de tout autre nom d'environnement dans votre organisation.

   • Nom à afficher : nom de l'environnement affiché dans l'interface utilisateur.
   • Description : facultatif. Description de l'environnement.
   • Instance : laissez le champ Instance vide. Les instances ne s'appliquent pas aux installations Apigee hybrid.
   • Groupe d'environnements : laissez le champ Groupe d'environnements vide pour le moment. Vous allez créer un groupe d'environnements à l'étape suivante.
   • Type de déploiement : pour la plupart des installations Apigee hybrid, sélectionnez l'option permettant de déployer des proxys d'API individuels. Vous pouvez éventuellement déployer une archive de l'environnement de configuration de votre proxy d'API. Pour en savoir plus, consultez la page Types de déploiements acceptés.
     Remarque : Le type de déploiement utilisé avec cet environnement ne peut pas être modifié après la création de l'environnement.
4. Cliquez sur Créer.

Remarque : Cette opération de création d'environnement peut prendre jusqu'à cinq minutes.

Une fois l'opération terminée, le nouvel environnement s'affiche dans le tableau du volet Environnements.

API Apigee

Pour créer un environnement à l'aide de l'API Create Environments, procédez comme suit :

1. Ouvrez un terminal sur l'appareil que vous utilisez pour gérer Apigee.

2. Sur la ligne de commande, obtenez vos identifiants d'authentification gcloud à l'aide de la commande suivante :

   Linux/MacOS

   export TOKEN=$(gcloud auth print-access-token)

   Pour vérifier que votre jeton a été renseigné, utilisez echo, comme le montre l'exemple suivant :

   echo $TOKEN

   Votre jeton doit s'afficher sous forme de chaîne encodée.

   Windows

   for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a

   Pour vérifier que votre jeton a été renseigné, utilisez echo, comme le montre l'exemple suivant :

   echo %TOKEN%

   Votre jeton doit s'afficher sous forme de chaîne encodée.

3. Créez la variable d'environnement suivante :

   Linux/MacOS

   export ENV_NAME="YOUR_ENV_NAME"

   Windows

   set ENV_NAME="YOUR_ENV_NAME"

   Où :

   • ENV_NAME (Obligatoire) Le nom de l'environnement peut contenir des lettres minuscules, des tirets et des chiffres. Il doit commencer par une lettre minuscule. Ce nom servira d'identifiant et ne peut pas être modifié après la création de l'environnement.
4. Appelez l'API Apigee suivante :

   Sans résidence des données

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json"   -d '{
       "name": "'"$ENV_NAME"'"
     }'   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

   Résidence des données

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json"   -d '{
       "name": "'"$ENV_NAME"'"
     }'   "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

   Si la requête aboutit, l'API Environments doit renvoyer un message semblable à celui-ci :

   {
     "name": "organizations/hybrid-example/operations/c2aee040-7e79-4fd4-b0cf-79ca1b7098a8",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
       "operationType": "INSERT",
       "targetResourceName": "organizations/hybrid-example/environments/example-env",
       "state": "IN_PROGRESS"
     }
   }

   Comme la propriété state dans la réponse indique qu'Apigee a commencé à créer le nouvel environnement, son état est donc IN_PROGRESS.

5. Vérifiez que l'environnement a bien été créé :

   Sans résidence des données

   curl -H "Authorization: Bearer $TOKEN" \
             "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

   Résidence des données

   curl -H "Authorization: Bearer $TOKEN" \
             "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

   Si la requête de création aboutit, l'API Environments renvoie un message semblable à celui-ci :

   [
     "your-environment-name"
   ]

Créer un groupe d'environnements

Créez maintenant un groupe d'environnements et attribuez-lui l'environnement que vous venez de créer.

Interface utilisateur d'Apigee

Pour créer un groupe d'environnements dans l'UI Apigee, procédez comme suit :

1. Dans l'interface utilisateur Apigee, accédez à Gestion > Environnements > Groupes d'environnements.

   Accéder à la page "Groupes d'environnements"

2. Dans le volet Environnements, sélectionnez Groupes d'environnements.
3. Cliquez sur + Créer un groupe d'environnements.
4. Saisissez ce qui suit :
   • Nom du groupe d'environnements : nom à attribuer au groupe d'environnements. Le nom doit commencer et se terminer par un caractère alphanumérique. Il peut comporter jusqu'à 63 caractères (caractères alphanumériques et tirets). Le nom doit être différent de tout autre nom de groupe d'environnements existant dans votre organisation.

   • Noms d'hôte : liste des noms d'hôte pouvant être utilisés pour appeler des proxys. Chaque nom d'hôte doit figurer sur une ligne distincte.

     Remarque : Les noms attribués à un groupe d'environnement doivent être uniques pour ce groupe. Ils ne peuvent pas être utilisés par d'autres groupes d'environnements.

     Vous pouvez également cliquer sur Configurer l'équilibreur de charge Google avec ces domaines. La page Équilibrage de charge de la console Cloud s'affiche, dans laquelle vous pouvez configurer l'équilibrage de charge pour les noms d'hôte.

   • Environnements : liste facultative des environnements à inclure dans le groupe d'environnements.
5. Cliquez sur Créer.

Remarque : Cette opération peut prendre jusqu'à cinq minutes.

API Apigee

Pour créer un groupe d'environnements à l'aide de l'API Apigee, procédez comme suit :

1. Sur la ligne de commande, obtenez vos identifiants d'authentification gcloud à l'aide de la commande suivante :

   Linux/MacOS

   TOKEN=$(gcloud auth print-access-token)

   Windows

   for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a

2. Créez les variables d'environnement suivantes :

   Linux/MacOS

   export DOMAIN="YOUR_DOMAIN"
   export ENV_GROUP="YOUR_ENVIRONMENT_GROUP"

   Windows

    data-terminal-prefix=">">set ENV_GROUP="YOUR_ENVIRONMENT_GROUP"
    data-terminal-prefix=">">set DOMAIN="YOUR_DOMAIN"

   Où :

   • DOMAIN (Obligatoire) Il s'agit du nom d'hôte utilisé par tous les proxys déployés dans les environnements de ce groupe. Il doit s'agir d'un domaine que vous gérez. L'adresse peut être le domaine lui-même, comme example.com, ou elle peut inclure un sous-domaine tel que my-proxies.example.com. Si vous ne possédez pas de domaine géré, vous pouvez saisir un espace réservé pour le moment. Vous pouvez modifier l'adresse du domaine ultérieurement.
   • ENV_GROUP (Obligatoire) Le nom de l'environnement peut contenir des lettres minuscules, des tirets et des chiffres. Il doit commencer par une lettre minuscule. Ce nom servira d'identifiant et ne sera pas modifiable après sa création.
3. Créez le groupe d'environnements :

   Sans résidence des données

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
      -d '{
        "name": "'"$ENV_GROUP"'",
        "hostnames":["'"$DOMAIN"'"]
      }' \
      "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"
       

   Résidence des données

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
      -d '{
        "name": "'"$ENV_GROUP"'",
        "hostnames":["'"$DOMAIN"'"]
      }' \
      "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"
       

4. Attribuez l'environnement au nouveau groupe :

   Sans résidence des données

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
      -d '{
        "environment": "'"$ENV_NAME"'",
      }' \
      "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"
       

   Résidence des données

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
      -d '{
        "environment": "'"$ENV_NAME"'",
      }' \
      "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"
       

5. Vérifiez si le groupe d'environnements a bien été créé à l'aide de la commande CURL suivante :

   Sans résidence des données

   curl -H "Authorization: Bearer $TOKEN" \
     "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

   Résidence des données

   curl -H "Authorization: Bearer $TOKEN" \
     "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

   Si la requête de création aboutit, l'API Environments Group renvoie un message semblable à celui-ci :

         {
           "environmentGroups": [
             {
               "name": "your_envgroup_hybrid",
               "hostnames": [
                 "apigee.hybrid.com"
               ],
               "createdAt": "1677826235324",
               "lastModifiedAt": "1677826235324",
               "state": "ACTIVE"
             }
           ]
         }
       

6. Récupérez les derniers rattachements pour le nouveau groupe d'environnements à l'aide de la commande CURL suivante :

   Sans résidence des données

   curl -H "Authorization: Bearer $TOKEN" \
     "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"

   Résidence des données

   curl -H "Authorization: Bearer $TOKEN" \
     "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"

   La création et l'association du groupe d'environnements ont abouti si le résultat affiche une valeur de hachage unique, comme indiqué dans l'exemple de résultat de réponse ci-dessous :

   
           {
             "environmentGroupAttachments": [
               {
                 "name": "c27046d1-b83e-4cba-xxxx-caaa660b2bd6",
                 "environment": "your_envtest_hybrid",
                 "createdAt": "1677826263567",
                 "environmentGroupId": "your_envgroup_hybrid"
               }
             ]
           }
           

Étape suivante

Pour continuer l'installation, passez à la Partie 2 : Configuration de l'environnement d'exécution hybride.