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

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.

Autorisations requises

Le créateur de l'environnement et du groupe d'environnement doit disposer au minimum du rôle Administrateur de l'organisation Apigee. Toutefois, si vous êtes le propriétaire du projet, vous êtes automatiquement autorisé à créer un environnement ou un groupe d'environnement. Toutefois, si vous déléguez cette tâche à un utilisateur qui n'est pas propriétaire du projet, cet utilisateur doit disposer du rôle "Administrateur de l'organisation Apigee" dans votre projet. Pour obtenir des informations sur l'attribution des rôles, consultez la section Accorder, modifier et révoquer les accès aux ressources.

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'UI Apigee hybrid ou de la CLI. Afin de vous familiariser avec l'UI, vous pouvez l'utiliser pour suivre ces étapes.

UI Apigee Hybrid

Pour accéder à l'interface utilisateur hybride 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 que vous avez créé à l'étape 2 : Créer un projet Google Cloud. Cliquez ensuite sur Autoriser.
  2. Votre navigateur vous redirige vers la page de destination principale de l'interface utilisateur hybride :

    Page de destination dans l'interface utilisateur Apigee hybrid, composée du volet de navigation à gauche et de grandes images sous forme de liens

  3. Assurez-vous que votre organisation compatible hybride 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 :

    Liste des organisations compatibles hybride

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

    Menu de l'UI Apigee hybrid avec les options "Administration", "Environnements", "Présentation" affichées

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

    Vue "Environments", qui est vide (aucun environnement)

  5. Cliquez sur +Environment.

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

    Boîte de dialogue "New environment"

  6. 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".

      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).
  7. Cliquez sur Créer.

    Apigee crée le nouvel environnement et affiche l'état Pending Provisioning (En attente de provisionnement) :

    Message d'état "En attente de provisionnement"

    L'état passe à provisionné après quelques instants :

    Message indiquant qu'un nouvel environnement a été provisionné

    Mais vous n'avez pas tout à fait terminé. Vous devez également ajouter votre nouvel environnement au fichier overrides.yaml de l'environnement d'exécution. Vous devez donc commencer par installer l'environnement d'exécution.

gcloud CLI

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, comme le montre l'exemple suivant :

    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.

    Pour en savoir plus, consultez la section présentation de l'outil de ligne de commande gcloud.

  3. Créez des variables d'environnement pour les éléments de l'environnement. Vous allez utiliser la variable suivante dans la commande pour les créer :
    • ENV_NAME (obligatoire) est l'ID programmatique de votre environnement. 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.
      export ENV_NAME=environment_name
    • ENV_DISPLAY_NAME (obligatoire) est le nom descriptif de votre environnement. Cette valeur n'a pas besoin d'être unique et peut inclure des espaces et des caractères spéciaux. Exemple : "Mon exemple d'environnement".
      ENV_DISPLAY_NAME=friendly_name
    • ORG_NAME (obligatoire) est l'ID de votre organisation. Assurez-vous d'avoir défini la variable d'environnement ORG_NAME à l'étape 4 : Créer une organisation :
      echo $ORG_NAME
    • ENV_DESCRIPTION (Facultatif) contient des informations sur l'organisation, que vous souhaitez utiliser comme rappel de son objectif. Par exemple, "Exemple d'environnement pour les instructions Apigee Hybrid".
      ENV_DESCRIPTION=description_text
  4. Envoyez une requête POST authentifiée à l'API Create Environments.

    L'exemple suivant montre la structure de requête qui crée une organisation à l'aide de la commande suivante :

    curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json"   -d '{
        "name": "'"$ENV_NAME"'",
        "displayName": "'"$ENV_DISPLAY_NAME"'",
        "description": "'"$ENV_DESCRIPTION"'"
      }'   "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. Ce processus peut prendre plusieurs minutes.

Créer un groupe d'environnements

Créez maintenant un groupe d'environnements et attribuez-lui l'environnement que vous venez de créer. Les groupes d'environnements vous permettent de regrouper des environnements et de fournir des noms d'hôte pour acheminer les proxys déployés dans les environnements du groupe. Vous devez créer au moins un groupe d'environnements, et vous devez attribuer au moins un nom d'hôte au groupe. Pour obtenir une présentation des groupes d'environnements, consultez la section À propos des groupes d'environnements.

UI Apigee Hybrid

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.
  2. Votre navigateur vous redirige vers la page de destination principale de l'interface utilisateur hybride.

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

    La vue Environment Groups Overview (Présentation des groupes d'environnement) s'affiche, avec tous les groupes d'environnement créés :

    Vue "Groupes d'environnements", affichant tous les groupes créés

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

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

    Boîte de dialogue "Ajouter un groupe d'environnements", affichant un champ "Nom" vide

  6. Saisissez un nom, puis cliquez sur Add (Ajouter).
  7. Gardez le pointeur de la souris sur le groupe d'environnement nouvellement créé, puis cliquez sur Edit (Modifier) .

    Ajoutez un nom d'hôte que tous les proxys déployés dans les environnements de ce groupe utiliseront. Il s'agit du domaine que vous avez utilisé à l'étape 5 : Configurer votre DNS.

  8. Fenêtre "Modifier le groupe d'environnements", affichant aucun environnement attribué

  9. Cliquez sur Add (+) (Ajouter).
  10. La boîte de dialogue Add environment (Ajouter un environnement) s'affiche.
  11. Boîte de dialogue "Ajouter un environnement", qui répertorie les environnements disponibles

  12. Sélectionnez un environnement dans la liste, puis cliquez sur Add (Ajouter).

gcloud CLI

Pour créer un groupe d'environnements à l'aide de la ligne de commande, procédez comme suit :

  1. Sur la ligne de commande, obtenez vos identifiants d'authentification gcloud, comme le montre l'exemple suivant :

    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.

    Pour en savoir plus, consultez la section présentation de l'outil de ligne de commande gcloud.

  2. Vérifiez que la variable d'environnement DOMAIN est définie, comme illustré dans l'exemple suivant :
    echo $DOMAIN

    Il s'agit du nom d'hôte utilisé par tous les proxys déployés dans les environnements de ce groupe. Utilisez le même domaine que celui utilisé à l'étape 5 : Configurer votre DNS.

    Si ce n'est pas le cas, créez-la avec le domaine que vous prévoyez d'utiliser pour l'installation Apig hybride. Exemple :

    export DOMAIN=domain-name.com
  3. Assurez-vous que la variable d'environnement ENV_NAME est définie sur l'environnement que vous venez de créer aux étapes précédentes. Exemple :
    echo $ENV_NAME
  4. Créez une variable d'environnement pour le nom du groupe d'environnements souhaité. Exemple :
    export ENV_GROUP=environment-group-name
  5. Créez le groupe d'environnements à l'aide de la commande suivante :
    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"
        
  6. Attribuez l'environnement au nouveau groupe à l'aide de la commande suivante :
    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"
        

Étape suivante

Pour continuer l'installation, consultez la section Installation de l'environnement d'exécution : Avant de commencer.