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

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

Version 1.11 

   Versions compatibles :

• v1.13 (la plus récente)
• v1.12
• v1.11                         
• Liste des versions compatibles

   Versions non compatibles :

• 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.

Remarque : Il existe une nouvelle version de l'interface utilisateur Apigee, intégrée à la console Google Cloud. La nouvelle interface utilisateur est appelée Apigee dans la console Cloud. Les instructions des deux premiers onglets ci-dessous expliquent comment utiliser Apigee dans la console Cloud ou la version classique d'Apigee.

Apigee dans la console Cloud

Pour créer un environnement dans Apigee dans la console Cloud, procédez comme suit :

1. Ouvrez l'interface utilisateur d'Apigee dans la console Cloud dans un navigateur.
2. Sélectionnez Gestion > Environnements dans le volet de navigation de gauche.
3. Dans le volet Environnements, cliquez sur + Créer un environnement.
4. 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.
5. 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.

Interface utilisateur classique d'Apigee

Pour accéder à l'interface utilisateur et ajouter un environnement, procédez comme suit :

1. Ouvrez l'interface utilisateur Apigee. Si vous vous connectez pour la première fois, une fenêtre affiche une boîte de dialogue de collecte du consentement. Si vous êtes invité à sélectionner parmi plusieurs comptes, choisissez celui auquel appartient le projet Google Cloud que vous utilisez pour installer Apigee hybrid. Cliquez ensuite sur Autoriser.

Votre navigateur vous redirige vers la page de destination principale de l'interface utilisateur :



2. Assurez-vous que votre organisation est sélectionnée dans la liste déroulante. Si ce n'est pas le cas, sélectionnez-la dans la liste déroulante, comme illustré dans l'exemple suivant :

   

3. Cliquez sur Admin > Environments > Overview (Administration -> Environnements -> Présentation).

   

   La vue Environments s'affiche, sans environnement (pour l'instant) :

4. Cliquez sur +Environment.

   La boîte de dialogue New environment (Nouvel environnement) s'affiche :

   

5. Saisissez les informations suivantes dans la boîte de dialogue New Environment :
   1. Display name (Nom à afficher) (obligatoire) : nom descriptif de l'environnement utilisé dans l'interface utilisateur. Par exemple, "Mon premier environnement" ou "test". Contrairement au nom de l'environnement, le nom à afficher peut inclure des majuscules et d'autres caractères spéciaux.
   2. Environment name (Nom de l'environnement) (obligatoire) : nom programmatique de l'environnement, également appelé ID d'environnement.

      Par exemple, "mon-environnement" ou "test".

      Attention : Le nom d'un environnement ne peut contenir que des lettres minuscules, des chiffres et des traits d'union. Vous ne pouvez pas utiliser de lettres majuscules ni d'autres caractères spéciaux. De plus, le nom de l'environnement peut comporter jusqu'à 32 caractères. Par exemple : my-test-env ou my-test-env-42.

      Le nom à afficher et le nom de l'environnement peuvent être différents.

   3. Description (facultatif) : informations supplémentaires sur l'environnement que vous souhaitez ajouter comme rappel de son objectif. Exemple : "Created during initial installation" (Créé lors de l'installation initiale).
6. Conservez les autres valeurs par défaut, puis cliquez sur Créer.

   Apigee crée le nouvel environnement.

   Vous devez maintenant créer un groupe d'environnements et y ajouter votre nouvel environnement.

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 :

   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"

   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éé :

   curl -H "Authorization: Bearer $TOKEN" \
             "https://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.

Apigee dans la console Cloud

Pour créer un groupe d'environnements dans Apigee dans la console Cloud, procédez comme suit :

1. Ouvrez l'interface utilisateur d'Apigee dans la console Cloud dans un navigateur.
2. Sélectionnez Gestion > Environnements dans le volet de navigation de gauche.
3. Dans le volet Environnements, sélectionnez Groupes d'environnements.
4. Cliquez sur + Créer un groupe d'environnements.
5. 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.
6. Cliquez sur Créer.

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

Interface utilisateur classique d'Apigee

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

1. Ouvrez l'interface utilisateur Apigee.

Votre navigateur vous redirige vers la page de destination principale de l'interface utilisateur Apigee :

2. Assurez-vous que votre organisation est sélectionnée dans la liste déroulante. Si ce n'est pas le cas, sélectionnez-la dans la liste déroulante.
3. Cliquez sur Admin > Environments > Groups (Admin > Environnements > Groupes).

   La vue Présentation des groupes d'environnement s'affiche :

   

4. Cliquez sur +Environment Group (+groupe d'environnements).

   La boîte de dialogue Add an Environment Group (Ajouter un groupe d'environnements) s'affiche.

   

5. Saisissez un nom et cliquez sur Ajouter.

6. Gardez le pointeur de la souris sur le groupe d'environnement nouvellement créé, puis cliquez sur Modifier .

   Ajoutez un nom d'hôte que tous les proxys déployés dans les environnements de ce groupe utiliseront. Il doit s'agir d'un domaine pour lequel vous disposez d'un accès de niveau "Gestionnaire". Le nom d'hôte peut être le domaine lui-même, comme example.com, ou il peut inclure un sous-domaine tel que my-proxies.example.com.

   Si vous devez enregistrer un domaine, passez par un service d'enregistrement de noms de domaine tel que Google Domains.

   Si vous le souhaitez, vous pouvez configurer un équilibreur de charge pour le domaine. Pour en savoir plus sur les équilibreurs de charge, consultez la page Présentation de Cloud Load Balancing.

   

7. Cliquez sur Ajouter (+) dans la zone Environnements.
8. La boîte de dialogue Add environment (Ajouter un environnement) s'affiche.

   

9. Sélectionnez un environnement dans la liste, puis cliquez sur Ajouter.
10. Cliquez sur Enregistrer.

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 :

   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"
       

4. Attribuez l'environnement au nouveau groupe :

   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"
       

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

   curl -H "Authorization: Bearer $TOKEN" \
     "https://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 :

   curl -H "Authorization: Bearer $TOKEN" \
     "https://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.