Création d’un déploiement de version Canary

Connectez-vous à la console API Gateway.

Choisissez une API REST existante ou créez-en une.

Dans le volet de navigation principal, choisissez Resources, puis Déployer l’API. Suivez les instructions à l’écran dans Deploy API pour déployer l’API dans une nouvelle étape.

À ce stade, vous avez déployé l’API dans une étape de version de production. La prochaine étape va consister à configurer les paramètres Canary au niveau de l’étape et, si nécessaire, à activer la mise en cache, à définir des variables d’étape ou à configurer des journaux d’accès ou d’exécution d’API.

Pour activer la mise en cache des API ou associer une ACL AWS WAF Web à l'étape, dans la section Détails de l'étape, choisissez Modifier. Pour plus d’informations, consultez Paramètres de cache pour REST APIs dans API Gateway ou Pour associer une liste ACL web AWS WAF à une étape d’API API Gateway à l’aide de la console API Gateway.

Pour configurer la journalisation d’exécution ou d’accès, dans la section Journaux et suivi, choisissez Modifier et suivez les instructions à l’écran. Pour de plus amples informations, veuillez consulter Configuration de la CloudWatch journalisation pour REST APIs dans API Gateway.

Pour définir des variables d’étape, choisissez l’onglet Variables d’étape, puis suivez les instructions à l’écran pour ajouter ou modifier des variables d’étape. Pour de plus amples informations, veuillez consulter Utilisation de variables d’étape pour une API REST dans API Gateway.

Choisissez l’onglet Canary, puis choisissez Créer Canary. Vous devrez peut-être choisir la flèche droite pour afficher l'onglet Canary.

Sous Paramètres Canary, pour Canary, entrez le pourcentage de demandes à renvoyer vers le canary.

Si vous le souhaitez, sélectionnez Cache d’étape pour activer la mise en cache pour la version canary. Le cache n’est pas accessible à la version Canary tant que la mise en cache d’API n’est pas activée.

Pour remplacer les variables d’étape existantes, pour Remplacement canary, entrez une nouvelle valeur de variable d’étape.

À chaque mise à jour de l’API, choisissez Déployer l’API.

Dans Déployer l’API, choisissez l’étape qui contient un canary dans la liste déroulante Étape de déploiement.

(Facultatif) Entrez une description pour Description du déploiement.

Choisissez Deploy pour transférer (en mode push) la dernière version d’API vers la version Canary.

Si vous le souhaitez, reconfigurez les paramètres d’étape, les journaux ou les paramètres Canary, comme indiqué dans Pour créer le déploiement initial d’une version Canary.

Utilisez la commande create-deployment suivante pour créer un déploiement avec deux variables d'étape, mais sans canari :

aws apigateway create-deployment \
    --variables sv0=val0,sv1=val1 \
    --rest-api-id abcd1234 \
    --stage-name 'prod'

Le résultat se présente comme suit :

{
    "id": "du4ot1", 
    "createdDate": 1511379050
}

Utilisez la commande create-deployment suivante pour créer un déploiement Canary sur scène : prod

aws apigateway create-deployment \
    --rest-api-id abcd1234 \
    --canary-settings percentTraffic=10.5,stageVariableOverrides={sv1='val2',sv2='val3'},useStageCache=false \
    --stage-name 'prod'

Le résultat se présente comme suit :

{
    "id": "a6rox0", 
    "createdDate": 1511379433
}

L’id de déploiement obtenu identifie la version de test de l’API pour la version Canary. En conséquence, l’étape associée est activée pour Canary.

(Facultatif) Utilisez la commande get-stage suivante pour afficher la représentation de la scène :

aws apigateway get-stage --rest-api-id acbd1234 --stage-name prod

L’exemple suivant montre une représentation de Stage comme sortie de la commande :

{
    "stageName": "prod", 
    "variables": {
        "sv0": "val0", 
        "sv1": "val1"
    }, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": "du4ot1", 
    "lastUpdatedDate": 1511379433, 
    "createdDate": 1511379050, 
    "canarySettings": {
        "percentTraffic": 10.5, 
        "deploymentId": "a6rox0", 
        "useStageCache": false, 
        "stageVariableOverrides": {
            "sv2": "val3", 
            "sv1": "val2"
        }
    }, 
    "methodSettings": {}
}

Dans cet exemple, la version de base de l’API utilise les variables d’étape {"sv0":val0", "sv1":val1"}, tandis que la version de test utilise les variables d’étape {"sv1":val2", "sv2":val3"}. La version de production et la version Canary utilisent toutes les deux la même variable d’étape sv1, mais avec des valeurs différentes : val1 et val2, respectivement. La variable d’étape sv0 est seulement utilisée dans la version de production, alors que la variable d’étape sv2 est utilisée dans la version Canary uniquement.

Utilisez la commande create-deployment pour créer un déploiement sans canari :

aws apigateway create-deployment \
    --variables sv0=val0,sv1=val1 \  
    --rest-api-id abcd1234 \
    --stage-name 'beta'

Utilisez la commande update-stage pour mettre à jour le stage afin d'activer un Canary :

aws apigateway update-stage \
    --rest-api-id abcd1234 \
    --stage-name 'beta' \
    --patch-operations '[{
            "op": "replace",
            "value": "0.0",
            "path": "/canarySettings/percentTraffic"
        }, {
            "op": "copy",
            "from": "/canarySettings/stageVariableOverrides",
            "path": "/variables"
        }, {
            "op": "copy",
            "from": "/canarySettings/deploymentId",
            "path": "/deploymentId"
        }]'

Le résultat se présente comme suit :

{
    "stageName": "beta", 
    "variables": {
        "sv0": "val0", 
        "sv1": "val1"
    }, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": "cifeiw", 
    "lastUpdatedDate": 1511381930, 
    "createdDate": 1511380879, 
    "canarySettings": {
        "percentTraffic": 10.5, 
        "deploymentId": "cifeiw", 
        "useStageCache": false, 
        "stageVariableOverrides": {
            "sv2": "val3", 
            "sv1": "val2"
        }
    }, 
    "methodSettings": {}
}

Comme vous avez activé un Canary sur une version existante de l'API, la version de production (Stage) et la version Canary (canarySettings) pointent vers le même déploiement. Une fois que vous avez modifié l’API et que vous l’avez redéployée dans cette étape, la nouvelle version se trouve dans la version Canary, alors que la version de base reste dans la version de production. Cela se manifeste dans l’évolution de l’étape lorsque deploymentId est mis à jour dans la version Canary avec le nouvel id de déploiement et que deploymentId reste inchangé dans la version de production.