Buat penerapan rilis kenari

Masuk ke konsol API Gateway.

Pilih REST API yang ada atau buat REST API baru.

Di panel navigasi utama, pilih Resources, lalu pilih Deploy API. Ikuti petunjuk di layar di Deploy API untuk menerapkan API ke tahap baru.

Sejauh ini, Anda telah menerapkan API ke tahap rilis produksi. Selanjutnya, Anda mengonfigurasi pengaturan kenari di panggung dan, jika perlu, juga mengaktifkan caching, mengatur variabel tahap, atau mengonfigurasi eksekusi API atau log akses.

Untuk mengaktifkan caching API atau mengaitkan ACL AWS WAF web dengan stage, di bagian Detail tahap, pilih Edit. Untuk informasi selengkapnya, lihat Pengaturan cache untuk REST APIs di API Gateway atau Untuk mengaitkan ACL AWS WAF web dengan tahap API Gateway API menggunakan konsol API Gateway.

Untuk mengonfigurasi eksekusi atau mengakses logging, di bagian Log dan penelusuran, pilih Edit dan ikuti petunjuk di layar. Untuk informasi selengkapnya, lihat Siapkan CloudWatch logging untuk REST APIs di API Gateway.

Untuk mengatur variabel tahap, pilih tab variabel Tahap dan ikuti petunjuk di layar untuk menambah atau memodifikasi variabel tahap. Untuk informasi selengkapnya, lihat Menggunakan variabel stage untuk REST API di API Gateway.

Pilih tab Canary, lalu pilih Create canary. Anda mungkin perlu memilih tombol panah kanan untuk menampilkan tab Canary.

Di bawah pengaturan Canary, untuk Canary, masukkan persentase permintaan yang akan dialihkan ke kenari.

Jika diinginkan, pilih Cache tahap untuk mengaktifkan caching untuk rilis kenari. Cache tidak tersedia untuk rilis canary sampai caching API diaktifkan.

Untuk mengganti variabel tahap yang ada, untuk penggantian Canary, masukkan nilai variabel tahap baru.

Dengan setiap pembaruan API, pilih Deploy API.

Di Deploy API, pilih tahap yang berisi kenari dari daftar dropdown tahap Deployment.

(Opsional) Masukkan deskripsi untuk deskripsi Deployment.

Pilih Deploy untuk mendorong versi API terbaru ke rilis canary.

Jika diinginkan, konfigurasikan ulang pengaturan panggung, log, atau pengaturan kenari, seperti yang dijelaskan dalam. Untuk membuat penerapan rilis kenari awal

Gunakan perintah create-deployment berikut untuk membuat deployment dengan dua variabel tahap, tetapi tanpa canary:

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

Outputnya akan terlihat seperti berikut:

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

Gunakan perintah create-deployment berikut untuk membuat penyebaran kenari di panggung: prod

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

Outputnya akan terlihat seperti berikut:

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

Penerapan yang dihasilkan id mengidentifikasi versi uji API untuk rilis canary. Akibatnya, tahap terkait diaktifkan kenari.

(Opsional) Gunakan perintah get-stage berikut untuk melihat representasi tahap:

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

Berikut ini menunjukkan representasi dari Stage sebagai output dari perintah:

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

Dalam contoh ini, versi dasar API akan menggunakan variabel tahap{"sv0":val0", "sv1":val1"}, sedangkan versi pengujian menggunakan variabel tahap{"sv1":val2", "sv2":val3"}. Baik rilis produksi dan rilis kenari menggunakan variabel tahap yang samasv1, tetapi dengan nilai yang berbeda, val1 danval2, masing-masing. Variabel tahap sv0 digunakan hanya dalam rilis produksi dan variabel tahap sv2 digunakan hanya dalam pelepasan kenari.

Gunakan perintah create-deployment untuk membuat deployment tanpa canary:

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

Gunakan perintah update-stage untuk memperbarui stage untuk mengaktifkan kenari:

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"
        }]'

Outputnya akan terlihat seperti berikut:

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

Karena Anda mengaktifkan canary pada versi API yang ada, baik production release (Stage) dan canary release (canarySettings) mengarah ke penerapan yang sama. Setelah Anda mengubah API dan menerapkannya ke tahap ini lagi, versi baru akan berada di rilis canary, sementara versi dasar tetap dalam rilis produksi. Ini dimanifestasikan dalam evolusi tahap ketika rilis deploymentId dalam kenari diperbarui ke penerapan baru id dan rilis produksi tetap tidak berubah. deploymentId