Déployer un proxy d'API

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.

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.

Remarque : Vous ne pouvez pas apporter de modifications incrémentielles à une révision de proxy d'API et redéployer cette même révision sur Apigee. Pour déployer des modifications sur un proxy d'API, vous devez l'enregistrer en tant que nouvelle révision et le déployer.

Déployer un proxy d'API

Déployez une révision de proxy d'API comme décrit pour l'une des méthodes suivantes.

Interface utilisateur d'Apigee

Pour déployer un proxy d'API :

1. Dans la console Google Cloud , accédez à la page Développement de proxys > Proxys d'API.

   Accéder aux proxys d'API

2. Cliquez sur le proxy d'API que vous souhaitez déployer. L'interface utilisateur affiche la page Présentation :

   

3. Pour déployer vos modifications, cliquez sur Déployer pour afficher la boîte de dialogue Déployer :

   

4. 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.
5. 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.

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.

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.

Remarque : Apigee limite le nombre de requêtes de déploiement traitées par seconde. Si vous tentez d'envoyer un grand nombre de demandes de déploiement simultanément, il est possible que des échecs de déploiement se produisent en raison d'erreurs de délai avant expiration.

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/revisions/$REV/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 que vous pouvez utiliser, consultez 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"

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 que vous pouvez utiliser, consultez Définir des variables d'environnement pour les requêtes API Apigee.

Point clé : L'état des déploiements ne s'affiche pas dans la liste des déploiements. Pour afficher l'état de déploiement d'une révision de proxy d'API, consultez la section Afficher l'état du déploiement.

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

Point clé : L'état des déploiements ne s'affiche pas dans la liste des déploiements. Pour afficher l'état de déploiement d'un proxy d'API, consultez la section Afficher l'état du déploiement.

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 :

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

Remarque : Pour résoudre les problèmes de déploiement, consultez Erreurs de déploiement. Pour les problèmes liés aux règles, consultez Erreurs liées aux règles.