Creazione di una distribuzione di una release Canary

Accedere alla console API Gateway.

Crea una nuova REST API o scegline una esistente.

Nel riquadro di navigazione principale scegli Risorse, quindi seleziona Distribuisci l'API. Seguire le istruzioni visualizzate sullo schermo in Deploy API (Distribuisci API) per distribuire l'API in una nuova fase.

Al momento, l'API è stata distribuita in una fase della release di produzione. Configura quindi le impostazioni Canary nella fase e, se necessario, abilita il caching, imposta le variabili di fase o configura i log degli accessi o delle esecuzioni dell'API.

Per abilitare il caching dell'API o associare una lista di controllo degli accessi Web AWS WAF alla fase, scegli Modifica nella sezione Dettagli fase. Per ulteriori informazioni, consulta Impostazioni della cache per REST API in Gateway API o Per associare un'ACL web AWS WAF ad una fase API di Gateway API tramite la console Gateway API.

Per configurare la registrazione degli accessi o delle esecuzioni, scegli Modifica nella sezione Log e tracciamento e segui le istruzioni visualizzate sullo schermo. Per ulteriori informazioni, consulta Configurazione della registrazione dei log CloudWatch per REST API in Gateway API.

Per impostare le variabili di fase, scegli la scheda Variabili di fase e segui le istruzioni visualizzate sullo schermo per aggiungere o modificare le variabili di fase. Per ulteriori informazioni, consulta Utilizzo delle variabili di fase per una REST API in Gateway API.

Scegli la scheda Canary, quindi seleziona Crea Canary. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda Canary.

In Impostazioni di Canary, inserisci in Canary la percentuale di richieste da deviare al Canary.

Se lo desideri, seleziona Cache della fase per attivare il caching per la release Canary. La cache non è disponibile per la release Canary fino a quando non viene abilitato il caching dell'API.

Per sovrascrivere le variabili di fase esistenti, inserisci in Sostituzione canary un nuovo valore per la variabile di fase.

Con ogni aggiornamento dell'API scegli Distribuisci l'API.

In Distribuisci l'API scegli la fase contenente un canary nell'elenco a discesa Fase della distribuzione.

(Facoltativo) Immetti una descrizione in Descrizione distribuzione.

Scegliere Deploy (Distribuisci) per inviare la versione API più recente alla release Canary.

Se lo desideri, riconfigura le impostazioni della fase, i log o le impostazioni Canary, come descritto in Per creare la distribuzione di una release Canary iniziale.

Utilizza il seguente comando create-deployment per creare un’implementazione con due variabili di fase, ma senza un canary:

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

L'output sarà simile al seguente:

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

Utilizza il seguente comando create-deployment per creare una distribuzione canary per la fase prod:

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

L'output sarà simile al seguente:

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

Il valore id della distribuzione risultante identifica la versione di verifica dell'API per la release Canary. Di conseguenza, la fase associata è abilitata per la release Canary.

(Facoltativo) Utilizza il seguente comando get-stage per visualizzare la rappresentazione della fase:

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

Di seguito è illustrata una rappresentazione dell'oggetto Stage come output del comando:

{
    "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": {}
}

In questo esempio la versione di base dell'API usa le variabili di fase {"sv0":val0", "sv1":val1"}, mentre la versione di test usa le variabili di fase {"sv1":val2", "sv2":val3"}. Sia la release di produzione che la release Canary usano la stessa variabile di fase sv1, ma con valori diversi, val1 e val2, rispettivamente. La variabile di fase sv0 viene usata unicamente nella release di produzione e la variabile di fase sv2 viene usata unicamente nella release Canary.

Utilizza il comando create-deployment per creare un’implementazione senza un canary:

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

Utilizza il comando update-stage per aggiornare la fase e abilitare 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"
        }]'

L'output sarà simile al seguente:

{
    "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": {}
}

Poiché è stato abilitato un canary in una versione esistente dell’API, sia il rilascio di produzione (Stage) sia il rilascio canary (canarySettings) puntano alla stessa implementazione. Dopo aver modificato l'API e averla distribuita di nuovo in questa fase, la nuova versione sarà nella release Canary, mentre la versione di base rimane nella release di produzione. Ciò si manifesta nell'evoluzione della fase quando il valore deploymentId nella release Canary viene aggiornato al valore id della nuova distribuzione e il valore deploymentId nella release di produzione rimane invariato.