Gérer les déploiements

Cette page s'applique à Apigee et à Apigee hybrid.

Ce document explique comment créer et gérer des déploiements d'API. Consultez également la page Présentation des déploiements d'API. Une fois que vous avez créé une entité de déploiement, vous pouvez l'associer à une ou plusieurs versions de l'API.

Créer un déploiement

Vous pouvez créer un déploiement dans la console ou à l'aide de l'API REST.

Console

Pour créer un nouveau déploiement, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Cliquez sur une API pour en afficher les détails.
Dans l'onglet Déploiements, cliquez sur Ajouter un déploiement.
Spécifiez les détails du déploiement dans le formulaire Créer un déploiement :
- ID de déploiement : cliquez sur Spécifier un ID unique pour fournir éventuellement un ID unique au déploiement. Si vous omettez l'ID, le hub d'API le crée pour vous. L'ID doit contenir entre 4 et 500 caractères, et les caractères valides sont /[A-Z][a-z][0-9]-/.
- Nom du déploiement (obligatoire) : indiquez un nom à afficher pour le déploiement.
- Description : saisissez une description du déploiement.
- Type de déploiement : sélectionnez le type de déploiement. Les valeurs possibles sont définies dans un attribut système, et vous pouvez les modifier dans la section Gérer les attributs.
- URI de ressource (obligatoire) : indiquez un URI à la ressource d'exécution. Cet URI peut être utilisé pour gérer la ressource. Par exemple, si la ressource d'exécution est un proxy d'API Apigee, ce champ contient l'URI de l'interface utilisateur de gestion du proxy.
- Environnement : mappage de l'environnement sur ce déploiement. L'environnement correspond à l'attribut d'environnement défini par le système.
- Documentation : saisissez un lien vers la documentation du déploiement.
- SLO : indiquez le SLO pour ce déploiement. Cette valeur correspond à l'attribut de SLO défini par le système. Vous pouvez modifier les valeurs de cet attribut dans Gérer les attributs.
- Points de terminaison (obligatoire) : indiquez les points de terminaison auxquels cette ressource de déploiement écoute les requêtes API. Il peut s'agir d'une liste complète d'URI, de noms d'hôte ou d'adresses IP.
- Lien vers une version : associez le déploiement à une ou plusieurs versions de l'API.
- Attributs définis par l'utilisateur : paires clé/valeur définies par l'utilisateur. Vous pouvez ajouter des attributs définis par l'utilisateur dans Gérer les attributs.
Cliquez sur Créer.

REST

Pour ajouter un nouveau déploiement à l'aide de l'API Créer un déploiement, procédez comme suit :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement du hub d'API.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement du hub d'API.
DEPLOYMENT_ID : (facultatif) identifiant du déploiement. S'il n'est pas fourni, un ID généré par le système sera utilisé. Le nom doit être une chaîne de 4 à 500 caractères, dont les caractères valides sont /[a-z][A-Z][0-9]-_/.
DISPLAY_NAME : (obligatoire) nom à afficher du déploiement. Vous pouvez utiliser n'importe quel nom.
Attributs facultatifs : en plus du nom à afficher qui est requis, vous pouvez associer des attributs et des entités facultatifs à un déploiement. Ces éléments supplémentaires sont décrits à la section description des ressources de déploiement dans la documentation de référence de l'API REST.

Ajouter un déploiement à une version d'API

Une version peut être associée à un ou plusieurs déploiements. Cette section explique comment associer des déploiements à des versions. Vous pouvez associer des déploiements à une version au moment où vous créez la version, ou associer des déploiements à une version existante en la modifiant. Consultez les sections Créer une version d'API et Modifier une version.

Pour associer un déploiement à une version nouvelle ou existante, le déploiement doit déjà exister. Consultez la section Créer un déploiement.

Console

Pour ajouter un déploiement à une version, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Sélectionnez une API.
Dans le tableau Versions, localisez la version que vous souhaitez modifier.
Sélectionnez Modifier dans le menu "Actions" à droite de la ligne de la version, ou sélectionnez la version et cliquez sur Modifier la version sur la page d'informations.
Sous Lien vers un déploiement, sélectionnez un ou plusieurs déploiements à associer à la version, puis cliquez sur OK.
Cliquez sur Enregistrer.

REST

Exemple d'ajout d'un déploiement à une version :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement du hub d'API.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement d'API Hub.
API_NAME : nom de l'API possédant la version que vous souhaitez modifier.
VERSION_ID : ID unique de la version à modifier.
DEPLOYMENTS : nom de ressource complet d'un ou de plusieurs déploiements. Exemple : "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

Répertorier les déploiements

Cette section explique comment lister les déploiements. Vous pouvez répertorier tous les déploiements associés à toutes les versions d'une API ou répertorier tous les déploiements associés à une version spécifique.

Console

Pour lister les déploiements avec l'interface utilisateur, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Cliquez sur une API pour en afficher les détails.
Sélectionnez l'onglet Déploiements pour répertorier tous les déploiements associés à l'API.
Dans l'onglet Versions, sélectionnez une version si vous souhaitez afficher les déploiements associés à cette version.

REST

Pour répertorier tous les déploiements, utilisez l'API Répertorier les déploiements :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement du hub d'API.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement du hub d'API.

Obtenir les détails du déploiement

Cette section explique comment obtenir des informations détaillées sur un déploiement d'API.

Console

Pour afficher les détails d'un déploiement, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Cliquez sur une API pour en afficher les détails.
Sélectionnez l'onglet Déploiements pour répertorier tous les déploiements associés à l'API.
Sélectionnez le déploiement pour afficher sa page d'informations.

REST

Pour afficher les détails d'un déploiement, utilisez l'API Obtenir les détails du déploiement :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement du hub d'API.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement du hub d'API.
DEPLOYMENT_ID : ID unique du déploiement.

Supprimer un déploiement d'API

Cette section explique comment supprimer un déploiement d'API.

Console

Pour supprimer des ressources d'API avec l'interface utilisateur :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Cliquez sur une API pour en afficher les détails.
Sélectionnez l'onglet Déploiements pour répertorier tous les déploiements associés à l'API.
Localisez le déploiement que vous souhaitez supprimer.
Sélectionnez Supprimer dans le menu Action du déploiement.

REST

Pour supprimer une ressource d'API du hub d'API, utilisez l'API Supprimer le déploiement :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement du hub d'API.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement du hub d'API.
DEPLOYMENT_ID : ID unique du déploiement à supprimer.

Modifier un déploiement

Cette section explique comment modifier un déploiement.

Console

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Cliquez sur une API pour en afficher les détails.
Sélectionnez l'onglet Déploiements pour répertorier tous les déploiements associés à l'API.
Localisez le déploiement que vous souhaitez modifier.
Sélectionnez Modifier dans le menu d'actions du déploiement ou cliquez sur le déploiement, puis sur Modifier le déploiement dans le panneau "Informations sur le déploiement".

REST

Pour modifier un déploiement, utilisez l'API Appliquer un correctif au déploiement :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement du hub d'API.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement du hub d'API.
DEPLOYMENT_ID : ID unique du déploiement à modifier.
DEPLOYMENT_ATTRIBUTES : joignez les attributs que vous souhaitez modifier dans le corps de la requête. Les attributs modifiables sont décrits dans la description des ressources de déploiement dans la documentation de référence de l'API REST.