Déployer un proxy d'API

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

Consultez la documentation d'Apigee Edge.

Vous ne pouvez pas appeler un proxy d'API tant qu'il n'a pas été déployé. Après avoir créé un proxy d'API ou modifié un proxy existant, vous pouvez le déployer sur votre cluster.

Lorsque vous créez une nouvelle révision d'un proxy d'API sans modifier son chemin de base et que vous la déployez dans un environnement où elle est déjà déployée, la révision précédente n'est pas déployée et la nouvelle révision est déployée à la place.

Déployer un proxy d'API

Déployez une révision de proxy d'API, tel que décrit dans les sections suivantes.

Nouvel éditeur de proxys

Pour déployer un proxy d'API dans l'interface utilisateur d'Apigee :

Si vous utilisez l'interface utilisateur d'Apigee dans la console Cloud : sélectionnez Développement de proxys > Proxys d'API.

Si vous utilisez la version classique de l'interface utilisateur d'Apigee : sélectionnez Développer > Proxys d'API, puis dans le volet Proxys, sélectionnez l'environnement du proxy.
Cliquez sur le proxy d'API que vous souhaitez déployer. L'interface utilisateur affiche la page Présentation :
Pour déployer vos modifications, cliquez d'abord sur Déployer pour afficher la boîte de dialogue Déployer :
Saisissez ce qui suit :
- Révision : numéro de révision du proxy que vous souhaitez déployer.
- Environnement : environnement dans lequel vous souhaitez déployer le proxy.
- Compte de service (facultatif) : un compte de service pour le proxy.
Cliquez sur Déployer.

L'interface utilisateur lance le processus de déploiement de la révision sélectionnée.

Une fois le proxy déployé, la colonne État de la section Déploiements affiche une icône verte indiquant que la révision 1 du proxy est déployée.

Icône d'état du proxy déployé

Éditeur de proxy classique

Pour déployer un proxy d'API dans l'interface utilisateur d'Apigee :

Connectez-vous à l'UI Apigee.
Sélectionnez Développer > Proxys d'API.
L'interface utilisateur affiche une liste des proxys d'API et leur état de déploiement :
Dans la liste déroulante Environment (Environnement), sélectionnez l'environnement dans lequel vous souhaitez déployer le proxy d'API.
Cliquez sur le proxy d'API que vous souhaitez déployer.

L'interface utilisateur affiche l'onglet Présentation des proxys d'API. Cette vue comprend les sections Deployments (Déploiements), Proxy Endpoints (Points de terminaison du proxy) et Target Endpoints (Points de terminaison cibles) :

S'il s'agit d'un nouveau proxy d'API que vous n'avez pas encore déployé (ou d'un proxy d'API dont vous avez annulé le déploiement), la colonne Revision (Révision) indique Non déployé.
Dans la colonne Révision, développez la liste déroulante.
S'il s'agit d'un nouveau proxy d'API qui n'a jamais été déployé auparavant, la liste déroulante affiche uniquement 1 et Undeploy (Annuler le déploiement) :

Pour les proxys d'API comportant plusieurs révisions, la liste déroulante affiche toutes les révisions que vous pouvez choisir, ainsi que Undeploy (Annuler le déploiement).
Dans la liste déroulante, sélectionnez la révision que vous souhaitez déployer.
L'UI vous invite à confirmer le déploiement :
Cliquez sur Déployer.
L'interface utilisateur lance le processus de déploiement de la révision sélectionnée.

Remarque : Le déploiement du nouveau proxy par Apigee peut prendre quelques minutes.

Placez le curseur sur le lien Informations de la colonne "État" pour afficher l'état du déploiement. Si une ou plusieurs révisions ont déjà été déployées, vous pouvez surveiller l'état de leur annulation, comme illustré dans la figure suivante. Pour en savoir plus, consultez la section Déploiement sans temps d'arrêt.

Une fois le déploiement terminé, les informations sur l'état indiquent que la révision est entièrement déployée :

Notez que le déploiement n'est pas un processus instantané. Le modèle de déploiement cohérent à terme d'Apigee signifie qu'un nouveau déploiement sera effectué sur le cluster sur une courte période, et non immédiatement. Pour en savoir plus, consultez la section À propos du déploiement.

Pour en savoir plus sur la signification des indicateurs d'état et sur la vérification de l'état, consultez la section Afficher l'état du déploiement.

Vous pouvez également déployer la révision actuelle que vous modifiez dans l'onglet Develop (Développer). Lorsque vous effectuez cette opération, Apigee crée automatiquement une révision.

Cliquez sur la liste déroulante Deploy to: (Déployer sur :) env_name.

L'interface utilisateur affiche une liste d'environnements. Dans la colonne Révision, l'interface utilisateur répertorie la révision actuellement déployée (ou "‐‐" s'il n'y en a aucune).
Cliquez sur Déployer revision pour déployer la révision la plus récemment modifiée.
L'UI vous invite à confirmer le déploiement.
Cliquez sur Déployer.
L'interface utilisateur lance le processus de déploiement de la révision sélectionnée.

API Apigee

Les sections suivantes fournissent des exemples d'utilisation de l'API Apigee permettant de déployer des révisions de proxy d'API et de répertorier les déploiements de votre organisation.

Créer un rapport de modification de déploiement avant de déployer
Déployer une révision de proxy d'API à l'aide de l'API
Répertorier les déploiements d'un proxy d'API à l'aide de l'API

Consultez également la section Afficher l'état du déploiement.

Créer un rapport de modification de déploiement avant de déployer

Le déploiement d'un proxy dans plusieurs environnements du même groupe d'environnement peut entraîner des perturbations. Pour déterminer la probabilité que cela se produise, vous pouvez générer un rapport à l'aide de la méthode generateDeployChangeReport comme suit :

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

Cette commande renvoie un rapport de modification du déploiement qui vous avertit si un chemin de base du proxy que vous souhaitez déployer ne reçoit pas de trafic en raison d'un déploiement existant qui utilise déjà ce chemin de base.

Déployer une révision de proxy d'API à l'aide de l'API

Pour déployer une révision de proxy d'API, saisissez l'appel d'API suivant :

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X POST \
  -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.

Point clé : Si une révision de proxy d'API existante est déployée, définissez le paramètre de requête override sur true. Dans ce cas, Apigee déploie complètement la nouvelle révision avant d'annuler le déploiement de la révision existante, comme décrit dans la section Déploiement sans temps d'arrêt.

Voici un exemple de résultat de réponse : Dans cet exemple, la révision 1 du proxy d'API helloworld a bien été déployée dans l'environnement test :

{
  "environment": "test",
  "apiProxy": "helloworld",
  "revision": "1",
  "deployStartTime": "1559149080457"
}

Pour en savoir plus, consultez la section Déployer une révision de proxy d'API à l'aide de l'API.

Répertorier les déploiements à l'aide de l'API

Pour répertorier l'ensemble des déploiements des proxys d'API et des flux partagés de votre organisation, saisissez l'appel d'API suivant :

curl "https://apigee.googleapis.com/v1/organizations/$ORG/deployments" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Voici un exemple de réponse : Dans cet exemple, trois proxys d'API ont été déployés, y compris helloworld, qui a été déployé dans la section précédente.

{
  "deployments": [
    {
      "environment": "test",
      "apiProxy": "helloworld",
      "revision": "1",
      "deployStartTime": "1559149080457"
    },
    {
      "environment": "test",
      "apiProxy": "weather",
      "revision": "1",
      "deployStartTime": "1558620435217"
    },
    {
      "environment": "test",
      "apiProxy": "testproxy",
      "revision": "2",
      "deployStartTime": "1558635113086"
    }
  ]
}

gcloud

Les sections suivantes fournissent des exemples d'utilisation des commandes CLI gcloud apigee permettant de déployer les révisions de proxy d'API et de répertorier les déploiements de votre organisation.

Déployer une révision de proxy d'API à l'aide de la CLI gcloud
Répertorier les déploiements d'un proxy d'API à l'aide de la CLI gcloud

Consultez également la section Afficher l'état du déploiement.

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.

Déployer une révision de proxy d'API à l'aide de la CLI gcloud

Pour déployer une révision de proxy d'API, utilisez la commande gcloud suivante :

gcloud apigee apis deploy $REV --api=$API --environment=$ENV

Point clé : Si une révision de proxy d'API existante est déployée, définissez l'option override sur true. Dans ce cas, Apigee déploie complètement la nouvelle révision avant d'annuler le déploiement de la révision existante, comme décrit dans la section Déploiement sans temps d'arrêt.

Voici un exemple de résultat de réponse : Dans cet exemple, la révision 1 du proxy d'API helloworld a bien été déployée dans l'environnement test :

Using Apigee organization 'my-org'
apiProxy: helloworld
deployStartTime: '1598032332802'
environment: test
revision: '1'

Pour en savoir plus, consultez la section Déployer une révision de proxy d'API à l'aide de la CLI.

Répertorier les déploiements à l'aide de la CLI gcloud

Pour répertorier tous les déploiements de proxys d'API et de flux partagés pour votre organisation, utilisez la commande gcloud suivante :

gcloud apigee deployments list

Voici un exemple de réponse : Dans cet exemple, trois proxys d'API ont été déployés, y compris helloworld, qui a été déployé dans la section précédente.

Using Apigee organization `my-org`
 - apiProxy: helloworld
   deployStartTime: 1598032332802
   environment: test
   revision: 1
 - apiProxy: weather
   deployStartTime: 1558620435217
   environment: test
   revision: 1
 - apiProxy: testproxy
   deployStartTime: 1558635113086
   environment: test
   revision: 2

Pour en savoir plus, consultez la section Répertorier les déploiements à l'aide de la CLI.

Dépannage

Si vous ne parvenez pas à déployer votre proxy d'API, vérifiez si l'un des scénarios courants suivants peut s'appliquer.

Restrictions de dénomination pour les groupes d'environnements

Si le nom de votre groupe d'environnement ne respecte pas les restrictions de dénomination, votre proxy ne sera pas déployé. Dans certains cas, il est possible de créer un groupe d'environnements et d'y ajouter des environnements sans avoir à respecter ces restrictions. Toutefois, cela empêchera le déploiement du proxy.

Consultez la section Créer des groupes d'environnements pour obtenir une description des consignes et des restrictions de dénomination.

Environnement créé avec un nom d'environnement utilisé précédemment

Si vous créez un environnement portant le même nom qu'un environnement qui a été précédemment supprimé, votre proxy ne se déploiera pas. Par exemple, si vous avez créé un environnement nommé prod-1 après avoir créé et supprimé un environnement prod-1, vous devez le supprimer. Pour résoudre ce problème, procédez comme suit :

Dissociez l'environnement prod-1 de votre groupe d'environnements à l'aide de l'API.
Supprimez l'environnement prod-1 à l'aide de l'API.
Créez un environnement. Par exemple, prod-2.
Associez le nouvel environnement prod-2 à votre groupe d'environnements à l'aide de l'API.