本文說明如何設定及使用初期測試版部署作業,透過 Cloud Deploy 將應用程式部署至 Cloud Run (僅限服務,不含工作)。
初期測試部署是指逐步推出應用程式新版本,逐步增加傳送至新版本的流量百分比,同時監控應用程式的效能。這有助於及早發現潛在問題,並盡量減少對使用者的影響。
Cloud Run 的初期測試版部署作業運作方式
使用初期測試版部署策略部署至 Cloud Run 時,Cloud Deploy 會以新修訂版本更新現有服務。新修訂版本會收到指定百分比的流量,舊修訂版本則會繼續接收剩餘流量。隨著時間逐漸增加新修訂版本的流量分配比例。
使用 Cloud Deploy 時,您可以設定在單一或多個階段中,將 Canary 部署至 Cloud Run。
這裡的操作說明僅包含 Canary 設定專屬的內容。如需設定及執行部署管道的一般操作說明,請參閱「部署 Cloud Run 服務或工作」一文。
確認您具備必要權限
除了使用 Cloud Deploy 時需要的其他 Identity and Access Management 權限,您還需要下列權限,才能執行可能需要用於 Canary 部署作業的其他動作:
clouddeploy.rollouts.advance
clouddeploy.rollouts.ignoreJob
clouddeploy.rollouts.cancel
clouddeploy.rollouts.retryJob
clouddeploy.jobRuns.get
clouddeploy.jobRuns.list
clouddeploy.jobRuns.terminate
如要進一步瞭解哪些可用角色包含這些權限,請參閱「IAM 角色和權限」。
準備好「skaffold.yaml
」
skaffold.yaml
檔案定義了 Cloud Run 服務定義的轉譯和部署方式。如要將 Canary 部署至 Cloud Run,請確認它正確指向服務定義檔,並定義所有必要的建構構件 (例如容器映像檔)。除了標準部署所需的設定外,skaffold.yaml
本身不需要任何特殊的 Canary 專用設定。您可以使用 Skaffold 設定檔,管理自訂 Canary 階段的不同服務定義變體。
準備服務定義
您可以使用一般的 Cloud Run 服務定義檔,但不需要 traffic
節。Cloud Deploy 會為您管理最後一個成功修訂版本和新修訂版本之間的流量分配。
示例 service.yaml
(不含 traffic
節):
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
name: my-cloudrun-service
spec:
template:
spec:
containers:
- image: gcr.io/my-project/my-cloudrun-app
ports:
- containerPort: 8080
設定自動初期測試
在特定 Cloud Run 階段的推送管道定義中,直接設定自動化初期測試。Cloud Deploy 會自動指示 Cloud Run 根據指定的百分比,在最後一個穩定版本和新版本之間拆分流量。
serialPipeline:
stages:
- targetId: prod
profiles: []
strategy:
canary:
runtimeConfig:
cloudRun:
automaticTrafficControl: true
canaryDeployment:
percentages: [PERCENTAGES]
verify: true|false
predeploy:
actions: "PREDEPLOY_ACTION"
postdeploy:
actions: "POSTDEPLOY_ACTION"
在這項設定中:
PERCENTAGES 是以逗號分隔的百分比值清單,代表 Canary 增量,例如
[25, 50, 75]
。請注意,這不包括100
,因為在 Canary 中假設部署百分比為 100%,並由stable
階段處理。您可以啟用部署驗證 (
verify: true
)。啟用後,系統會在每個 Canary 階段新增verify
工作。PREDEPLOY_ACTION
與您在
skaffold.yaml
中使用的 ACTION_NAME 相同,可定義要在部署前執行的自訂動作。POSTDEPLOY_ACTION
與您在
skaffold.yaml
中使用的 ACTION_NAME 相同,用於定義部署後要執行的自訂動作。
設定自訂初期測試
您可以手動設定 Canary,不必完全依賴 Cloud Deploy 提供的自動化功能。透過自訂 Canary 設定,您可以在推送管道定義中指定下列項目:
推出階段名稱
在全自動 Canary 部署中,Cloud Deploy 會為您命名階段 (例如
canary-25
、canary-75
、stable
)。不過,使用自訂 Canary 時,您可以為每個階段命名,只要該名稱在 Canary 階段的所有階段中不重複,且符合資源 ID 限制即可。但最後階段 (100%) 的名稱必須是stable
。各階段的百分比目標
分別指定每個階段的百分比。
階段要使用的 Skaffold 設定檔
您可以為每個階段使用不同的 Skaffold 設定檔,也可以使用相同的設定檔,或任意組合。每個設定檔都可以使用不同的 Cloud Run 服務定義。您也可以為特定階段使用多個設定檔。Cloud Deploy 會合併這些項目。
階段是否有驗證工作
請注意,啟用驗證後,您也需要設定
skaffold.yaml
以進行驗證。階段是否有部署前或部署後作業
如要啟用部署前或部署後工作,請設定這些工作的
skaffold.yaml
。
自訂 Canary 支援所有目標類型。
自訂初期測試設定元素
下列 YAML 顯示完全自訂 Canary 部署階段的設定:
strategy:
canary:
# Custom configuration for each canary phase
customCanaryDeployment:
phaseConfigs:
- phaseId: "PHASE1_NAME"
percentage: PERCENTAGE1
profiles: [ "PROFILE_NAME" ]
verify: true | false
predeploy:
actions: "PREDEPLOY_ACTION"
postdeploy:
actions: "POSTDEPLOY_ACTION"
- …
- phaseId: "stable"
percentage: 100
profiles: [ "LAST_PROFILE_NAME" ]
verify: true|false
predeploy:
actions: "PREDEPLOY_ACTION"
postdeploy:
actions: "POSTDEPLOY_ACTION"
這個 YAML
PHASE1_NAME
是階段的名稱。每個階段名稱都不得重複。
[ "PROFILE_NAME" ]
這是要用於階段的設定檔名稱。您可以為每個階段使用相同的設定檔,也可以為每個階段使用不同的設定檔,或任意組合。此外,您也可以指定多個設定檔。Cloud Deploy 會使用您指定的所有設定檔,加上整體階段使用的設定檔或資訊清單。
stable
最後一個階段必須命名為
stable
。PERCENTAGE1
這是第一階段要部署的百分比。每個階段都必須有專屬的百分比值,且該值必須是整數百分比 (例如不得為
10.5
),階段也必須依遞增順序排列。verify: true|false
告知 Cloud Deploy 是否要為階段納入驗證工作。 請注意,如要讓每個階段都使用驗證,Skaffold 會使用相同的設定檔進行驗證,該設定檔是為該階段的算繪和部署作業指定。
PREDEPLOY_ACTION
與您在
skaffold.yaml
中使用的 ACTION_NAME 相同,可定義要在部署前執行的自訂動作。POSTDEPLOY_ACTION
與您在
skaffold.yaml
中用來定義部署後要執行的自訂動作的 ACTION_NAME 相同。
最後階段的百分比必須為 100
。系統會按照您在這個 customCanaryDeployment
節中設定的順序執行階段,但如果百分比值不是遞增順序,註冊發布管道的指令就會失敗並顯示錯誤。
請注意,自訂 Canary 的設定不包含 runtimeConfig
節。如果加入 runtimeConfig
,則視為自訂自動初期測試。
設定自訂自動初期測試
這項功能結合了自訂階段定義 (名稱、百分比、設定檔、驗證、掛鉤) 和 Cloud Deploy 的 Cloud Run 自動流量管理功能。您定義階段,但 Cloud Deploy 會根據百分比指示 Cloud Run 轉移流量。
如要設定這項功能,請在 strategy.canary
區塊中同時加入 runtimeConfig.cloudRun.automaticTrafficControl: true
設定和 customCanaryDeployment
區段 (定義 phaseConfigs
)。Cloud Deploy 會使用指定的 Skaffold 設定檔,算繪服務定義 (仍不應有 traffic
節),但會根據階段百分比自動管理流量。
serialPipeline:
stages:
- targetId: cloudrun-prod
profiles: []
strategy:
canary:
# Include runtimeConfig for automatic traffic management
runtimeConfig:
cloudRun:
automaticTrafficControl: true
# Include customCanaryDeployment for phase customization
customCanaryDeployment:
phaseConfigs:
- phaseId: "warmup-cr"
percentage: 10
profiles: ["base-config"] # Profile rendering service def (no traffic stanza)
verify: true
- phaseId: "scaling-cr"
percentage: 50
profiles: ["base-config"] # Can use the same profile
verify: true
- phaseId: "stable"
percentage: 100
profiles: ["base-config"]
verify: true
執行 Cloud Run Canary
註冊管道和目標:套用傳送管道和 Cloud Run 目標設定檔。
gcloud deploy apply --file=delivery-pipeline.yaml --region=REGION gcloud deploy apply --file=cloudrun-targets.yaml --region=REGION
推送管道包含所選執行階段的自動或自訂 Canary 設定。
建立版本:開始部署作業,並提供映像檔名稱。
gcloud deploy releases create RELEASE_NAME \ --delivery-pipeline=PIPELINE_NAME \ --region=REGION
由
PIPELINE_NAME
識別的推送管道包含本文所述的自動或自訂 Canary 設定。推進初期測試版本:
gcloud CLI
gcloud deploy rollouts advance ROLLOUT_NAME \ --release=RELEASE_NAME \ --delivery-pipeline=PIPELINE_NAME \ --region=REGION
其中:
ROLLOUT_NAME
是目前要推進至下一階段的推出作業名稱。RELEASE_NAME
是指這個推出作業所屬的版本名稱。PIPELINE_NAME
是您用來管理這個版本部署作業的發布管道名稱。REGION
是建立版本的區域名稱,例如us-central1
。必填。如要進一步瞭解
gcloud deploy rollouts advance
指令,請參閱 Google Cloud SDK 參考資料。Google Cloud 控制台
在推送管道清單中,按一下您的管道。
「推送 pipeline 詳細資料」頁面會以圖形呈現推送 pipeline 的進度。
在「推出」分頁的「發布管道詳細資料」下方,按一下推出作業的名稱。
系統隨即會顯示該推出作業的詳細資料頁面。
請注意,在本範例中,發布作業有
canary-50
階段和stable
階段。您的推出作業可能會有更多或不同的階段。按一下「進展至下一個推出階段」。
推出作業會推進至下一個階段。
略過的階段
如果您部署初期測試版本,但應用程式尚未部署至該執行階段,Cloud Deploy 會略過初期測試階段,並執行穩定階段。請參閱「首次略過階段」,瞭解發生這種情況的原因。
後續步驟
瞭解如何管理 Canary 推出作業的生命週期。
進一步瞭解平行部署。
進一步瞭解 Cloud Deploy 部署策略。
進一步瞭解 Cloud Run。