Présentation du déploiement

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

Consultez la documentation d' Apigee Edge.

Remarque : Pour annuler le déploiement de proxys d'API dans des environnements activés pour les déploiements d'archives, consultez la page Déployer et gérer des archives dans un environnement Apigee.

Lorsque vous modifiez un proxy d'API, vous pouvez l'enregistrer en tant que nouvelle révision et le déployer sur votre cluster.

Guide de démarrage rapide :

• Déployer un proxy d'API
• Annuler le déploiement d'un proxy d'API

À propos du déploiement

Le cycle de vie du déploiement d'une révision de proxy d'API sur Apigee est illustré dans la figure suivante.

Remarque : Dans Apigee, les MP agissent indépendamment les uns des autres et tout MP peut avoir un état différent de celui des autres (par exemple actif ou désactivé). C'est ce qu'on appelle un modèle de déploiement cohérent à terme pour les proxys d'API.

Limites des révisions du proxy d'API

Les limites suivantes s'appliquent aux révisions du proxy d'API :

• Si vous apportez des modifications à un proxy d'API, vous devez le déployer en tant que nouvelle révision.
• Après que vous avez déployé un proxy d'API, la révision est en lecture seule. Vous ne pouvez pas modifier une révision de proxy d'API (pour effectuer des modifications incrémentielles, par exemple). le seul moyen de modifier une révision consiste à créer une nouvelle révision et à la déployer.
• Les MP ne peuvent déployer un groupe de proxys que dans son intégralité. Si vous modifiez des règles ou des fragments individuels, les MP déploieront toujours l'intégralité du groupe de proxys.
• Si votre utilisation d'Apigee fait la distinction entre les proxys standards et d'extension, lors du déploiement d'une révision qui fait passer un proxy d'API d'un proxy standard à un proxy d'extension :
  • des frais peuvent s'appliquer. Si vous êtes un client facturé à l'usage, consultez les droits de paiement à l'usage. Si vous avez souscrit un abonnement, consultez les détails de votre forfait.
  • le déploiement nécessite plus de temps. Pendant la fenêtre de déploiement, le flux d'appels d'API n'est pas interrompu, mais vous ne pouvez pas déployer, désinstaller ni supprimer le proxy. De plus, les révisions actuelles ou nouvelles ne peuvent pas être supprimées pendant la période de déploiement. Les modifications apportées au proxy d'API et la création de nouvelles révisions sont autorisées.

Déploiement sans interruption

Tous les déploiements de proxy d'API réussis vers Apigee sont des déploiements sans interruption. Les déploiements de proxy d'API s'effectuent dans l'ordre suivant :

1. La révision 1 du proxy d'API /hello est déployée et gère le trafic.
2. La révision 2 de /hello est déployée.
3. La révision 2 est déployée sur les processeurs de messages du plan d'exécution.
4. Le déploiement de la révision 1 est annulé.

Le déploiement de la révision du proxy d'API est maintenant terminé sans interruption.

Remarque : Si le déploiement de la révision 2 échoue pour une raison quelconque, la version précédente (révision 1) n'est toujours pas déployée. Dans ce cas, vous pouvez redéployer la révision précédente pour la restaurer. Vous pouvez ensuite corriger la nouvelle révision et la déployer.

Afficher l'état du déploiement

Le déploiement d'un proxy d'API sur Apigee ne le rend pas immédiatement disponible. La synchronisation du proxy d'API entre tous les MP du plan d'exécution prend un certain temps. Toutefois, Apigee propose des outils qui peuvent vous fournir des informations sur l'état de vos révisions de proxy d'API.

Interface utilisateur classique d'Apigee

L'UI d'Apigee contient plusieurs vues indiquant l'état de déploiement de vos proxys d'API :

Affichage de l'UI d'Apigee

Étapes et description

les proxys ;

Sélectionnez Développer > Proxys d'API : Les icônes suivantes permettent à l'UI d'Apigee de fournir un état rapide pour chaque proxy d'API : indique que le proxy d'API n'a pas été déployé dans l'environnement sélectionné. indique qu'il n'existe aucune erreur ni avertissement pour ce proxy dans l'environnement sélectionné. indique qu'un routage n'a pas été mis à jour en raison de conflits de chemin de base. indique qu'une erreur s'est produite lors du déploiement du proxy d'API. Pour afficher l'icône d'état, cliquez sur l'onglet Develop (Développer). Vous pouvez également sélectionner Développer > Proxys d'API et cliquer sur un proxy d'API.

API Apigee

Pour afficher l'état de déploiement de la révision de proxy d'API dans un environnement, utilisez l'appel d'API suivant :

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Où $TOKEN est défini sur votre jeton d'accès OAuth 2.0, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0. Pour en savoir plus sur les options curl utilisées dans cet exemple, consultez la section Utiliser curl. Pour obtenir une description des variables d'environnement utilisées, consultez la section Définir des variables d'environnement pour les requêtes API Apigee.

Voici un exemple de réponse : Cet exemple illustre l'état de déploiement de la révision 1 du proxy d'API helloworld déployé dans l'environnement test :

{
  "environment": "test",
  "apiProxy": "helloworld",
  "revision": "1",
  "deployStartTime": "1559149080457",
  "pods": [
    {
      "podName": "apigee-runtime-myorg-test-f8bdf9d-2s72w",
      "deploymentStatus": "deployed",
      "statusCodeDetails": "Deployment Success",
      "podStatus": "active",
      "podStatusTime": "1595357668001"
    }
  ],
  "state": "READY"
}

Pour en savoir plus, consultez la page sur la ressource REST : organizations.environments.apis.revisions.deployments.

gcloud

Pour afficher l'état de déploiement de la révision de proxy d'API dans un environnement, exécutez la commande gcloud suivante :

gcloud alpha apigee deployments describe --api=$API --environment=$ENV

Pour en savoir plus et obtenir une description des variables d'environnement utilisées dans les exemples, consultez la page Premiers pas avec Apigee à l'aide de gcloud.

Voici un exemple de réponse : Cet exemple illustre l'état de déploiement de la révision 1 du proxy d'API helloworld déployé dans l'environnement test :

Using Apigee organization `my-org`
Using deployed revision `1`
apiProxy: helloworld
deployStartTime: '1598032332802'
environment: test
pods:
- deploymentStatus: deployed
  podName: apigee-runtime-myorg-test-f8bdf9d-2s72w
  podStatus: active
  podStatusTime: '1598302128087'
  statusCodeDetails: Deployment Success
revision: '1'
state: READY

Pour en savoir plus, consultez la page sur la commande de description des déploiements.

Afficher l'utilisation du déploiement de proxy

L'utilisation de proxys d'API dans votre organisation peut être soumise à un quota de déploiements, qui correspond à une limite du nombre d'unités de déploiement que vous pouvez utiliser à la fois. Pour en savoir plus, consultez vos droits d'accès (Pay-as-you-go ou abonnement 2024). Vous pouvez consulter l'utilisation du déploiement de proxy de votre organisation à plusieurs endroits dans l'interface utilisateur d'Apigee dans la console Cloud, comme décrit ci-dessous.

Remarque : Si votre organisation est compatible avec Apigee hybrid, seul un sous-ensemble de ces métriques d'utilisation est affiché.

Afficher l'utilisation du déploiement sur la page "Vue d'ensemble" d'Apigee

Pour afficher l'utilisation de votre déploiement de proxy d'API à partir de la page Aperçu d'Apigee :

1. Ouvrez la page Vue d'ensemble de l'interface utilisateur d'Apigee dans la console Google Cloud.

   Accéder à la page "Présentation"

2. Vous pouvez consulter en un clin d'œil l'utilisation du déploiement de proxy pour votre organisation à l'aide de la fiche Utilisation du proxy, qui affiche les informations suivantes pour votre organisation :
   • Nombre total de proxys créés : nombre total de proxys d'API créés, y compris les proxys déployés et non déployés.
   • Proxys déployés : nombre total de proxys d'API déployés dans tous les environnements de l'organisation.
   • Unités de déploiement de proxy : nombre total de proxys d'API ou de révisions de flux partagés déployées dans votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.
   • Proxys et flux partagés déployés par rapport à la limite : nombre total de proxys d'API et de flux partagés déployés dans l'organisation, par rapport à la limite de votre type d'organisation.
   • Unités de déploiement extensibles : nombre de révisions de proxy d'API extensibles déployées dans votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.
   • Unités de déploiement standards : nombre de révisions de proxy d'API standards déployées dans votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.

Afficher l'utilisation du déploiement sur la page "Proxys d'API"

Pour afficher l'utilisation de votre déploiement de proxy d'API à partir de la page Proxys d'API :

1. Ouvrez la page Proxys d'API dans l'interface utilisateur Apigee de la console Google Cloud.

   Accéder aux proxys d'API

2. La page Proxys d'API affiche les informations suivantes :
   • Nombre total de proxys créés : nombre total de proxys d'API développés dans votre organisation, y compris les proxys déployés et non déployés.
   • Proxys déployés : nombre total de révisions de proxy d'API déployées dans tous les environnements de votre organisation.
   • Unités de déploiement de proxy : nombre total de révisions de proxy d'API ou de flux partagés déployées dans tous les environnements de votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.
   • Unités de déploiement de proxys Extensible : nombre de révisions de proxys d'API extensibles déployées dans tous les environnements de votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.
   • Unités de déploiement de proxy standards : nombre de révisions de proxy d'API standards déployées dans tous les environnements de votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.

Afficher l'utilisation du déploiement sur la page "Environnements"

Pour afficher l'utilisation de votre déploiement de proxy d'API à partir de la page Environnements :

1. Ouvrez la page Environnements dans l'interface utilisateur d'Apigee de la console Google Cloud.

   Accéder à la page Environnements

2. Sélectionnez l'onglet Environnements pour afficher les informations suivantes pour tous les environnements :
   • Total des unités de déploiement de proxy : nombre total de révisions de proxy d'API ou de flux partagés déployées dans tous les environnements de votre organisation.
   • Unités de déploiement de proxys Extensible : nombre de révisions de proxys d'API extensibles déployées dans tous les environnements de votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.
   • Unités de déploiement de proxy standards : nombre de révisions de proxy d'API standards déployées dans tous les environnements de votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.
   • Unités de déploiement de flux partagés : nombre total de révisions de flux partagés déployées dans tous les environnements de votre organisation. Chaque déploiement par environnement et par instance est comptabilisé comme une unité.
3. Pour afficher l'utilisation du déploiement de proxy pour un seul environnement :
   1. Dans la liste Environnements, sélectionnez le nom d'un environnement pour afficher ses détails.
   2. Sélectionnez l'onglet Déploiements pour afficher l'utilisation des unités de déploiement pour l'environnement sélectionné.

Étapes suivantes

Déploiement : Déployer un proxy d'API

Apprenez comment annuler un déploiement : Annuler le déploiement d'un proxy d'API