アプリケーションをターゲットにカナリア デプロイする

Skaffold 構成とアプリケーション マニフェストを準備する

Cloud Deploy では、Skaffold を使用して、デプロイする対象と、それをターゲットに適切にデプロイする方法の詳細を提供します。

このクイックスタートでは、デプロイする Kubernetes マニフェストまたは Cloud Run サービス構成を識別する skaffold.yaml ファイルを作成します。

1. ターミナル ウィンドウを開きます。

2. 新しいディレクトリを作成し、そのディレクトリに移動します。

   GKE

   mkdir deploy-canary-quickstart-gke
   cd deploy-canary-quickstart-gke
   

   GKE と Gateway API

   mkdir deploy-canary-quickstart-gke-gatewayapi
   cd deploy-canary-quickstart-gke-gatewayapi
   

   Cloud Run

   mkdir deploy-canary-quickstart-run
   cd deploy-canary-quickstart-run
   

3. 次の内容のファイルを skaffold.yaml という名前で作成します。

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - kubernetes.yaml
   deploy:
     kubectl: {}
   

   GKE と Gateway API

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - kubernetes.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - run.yaml
   deploy:
     cloudrun: {}
   

   このファイルは、マニフェストを識別する最小限の Skaffold 構成ファイルです。このクイックスタートでは、このファイルを作成します。ただし、Cloud Deploy で作成することで、単純な非本番環境アプリケーション用に作成することもできます。

   この構成ファイルの詳細については、skaffold.yaml リファレンスをご覧ください。

4. アプリケーション マニフェストを作成します。

   GKE

   deploy-canary-quickstart-gke ディレクトリに、次の内容のファイルを kubernetes.yaml という名前で作成します。

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
     labels:
       app: my-app
     namespace: default
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
       spec:
         containers:
         - name: nginx
           image: my-app-image
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: my-service
     namespace: default
   spec:
     selector:
       app: my-app
     ports:
       - protocol: TCP
         port: 80
   

   このファイルは Kubernetes マニフェストであり、アプリケーションをデプロイするためにクラスタに適用されます。このマニフェストには、カナリア デプロイに必要な Service リソースと Deployment リソースに加えて、Gateway API の使用に必要な HTTPRoute と Gateway リソースが含まれています。

   デプロイするコンテナ イメージは、ここでプレースホルダ my-app-image として設定されます。これは、リリースを作成するときに特定のイメージに置き換えられます。

   GKE と Gateway API

   deploy-canary-quickstart-gke-gatewayapi ディレクトリに、次の内容のファイルを kubernetes.yaml という名前で作成します。

   kind: Gateway
   apiVersion: gateway.networking.k8s.io/v1beta1
   metadata:
     name: my-gateway
     annotations:
       networking.istio.io/service-type: "ClusterIP"
   spec:
     gatewayClassName: istio
     listeners:
     - name: default
       hostname: "*.example.com"
       port: 80
       protocol: HTTP
       allowedRoutes:
         namespaces:
           from: All
   ---
   kind: HTTPRoute
   apiVersion: gateway.networking.k8s.io/v1beta1
   metadata:
     name: my-httproute
   spec:
     parentRefs:
     - kind: Gateway
       name: my-gateway
     hostnames:
     - "test.example.com"
     rules:
     - backendRefs:
       - name: my-service
         port: 80
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: my-service
   spec:
     selector:
       app: my-app
     ports:
     - name: tcp-port
       protocol: TCP
       port: 80
       targetPort: 8080
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
     labels:
       app: my-app
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
       spec:
         containers:
         - name: nginx
           image: my-app-image
   

   このファイルは Kubernetes マニフェストであり、アプリケーションをデプロイするためにクラスタに適用されます。このマニフェストには、カナリア デプロイに必要な Service リソースと Deployment リソースに加えて、Gateway API の使用に必要な HTTPRoute と Gateway リソースが含まれています。

   デプロイするコンテナ イメージは、ここでプレースホルダ my-app-image として設定されます。これは、リリースを作成するときに特定のイメージに置き換えられます。

   Cloud Run

   deploy-canary-quickstart-run ディレクトリに、次の内容のファイルを run.yaml という名前で作成します。

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: my-canary-run-service
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   このファイルは基本的な Cloud Run サービス定義であり、デプロイ時に適用され、Cloud Run でサービスを作成します。デプロイするコンテナ イメージは、ここでプレースホルダ my-app-image として設定されます。これは、リリースを作成するときに特定のイメージに置き換えられます。

デリバリー パイプラインとターゲットの作成

デリバリー パイプラインとターゲットは、1 つのファイルまたは個別のファイルで定義できます。このクイックスタートでは、パイプラインと 1 つのターゲットで、1 つのファイルを作成します。

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-canary-demo-app-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          kubernetes:
            serviceNetworking:
              service: "my-service"
              deployment: "my-deployment"
        canaryDeployment:
          percentages: [50]
          verify: false
---
apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: prod
description: prod GKE cluster
gke:
 cluster: projects/PROJECT_ID/locations/us-central1/clusters/canary-quickstart-cluster

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-canary-demo-app-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          kubernetes:
            gatewayServiceMesh:
              httpRoute: "my-httproute"
              service: "my-service"
              deployment: "my-deployment"
        canaryDeployment:
          percentages: [50]
          verify: false
---
apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: prod
description: prod GKE cluster
gke:
 cluster: projects/PROJECT_ID/locations/us-central1/clusters/canary-quickstart-cluster

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-canary-demo-app-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          cloudRun:
            automaticTrafficControl: true
        canaryDeployment:
          percentages: [50]
          verify: false
---
apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: prod
description: prod Run Service
run:
  location: projects/PROJECT_ID/locations/us-central1

1. パイプラインとターゲットを Cloud Deploy サービスに登録します。

   gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
   

   これで、カナリア デプロイ戦略用に 1 つのターゲットが構成されたパイプラインが作成されました。

2. 次のとおりに、パイプラインとターゲットを確認します。

   Google Cloud コンソールで、Cloud Deploy の [デリバリー パイプライン] ページに移動し、使用可能なデリバリー パイプラインのリストを表示します。

   [デリバリー パイプライン] ページを開く

   作成したデリバリー パイプラインが表示され、[ターゲット] 列に構成した 1 つのターゲットが一覧表示されます。

   

リリースを作成する

リリースは Cloud Deploy リソースの中心で、デプロイの変更を表します。デリバリー パイプラインは、そのリリースのライフサイクルを定義します。このライフサイクルの詳細については、Cloud Deploy のサービス アーキテクチャをご覧ください。

デプロイするコンテナ イメージを表す release リソースを作成するには、deploy-canary-quickstart-gke、deploy-canary-quickstart-gke-gatewayapi、または deploy-canary-quickstart-run ディレクトリから次のコマンドを実行します。

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-canary-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-canary-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-canary-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

--images= フラグに注目してください。これは、マニフェストまたはサービス定義のプレースホルダ（my-app-image）を、特定の SHA 修飾イメージに置き換えるために使用します。このようにマニフェストをテンプレート化し、リリースの作成時に SHA 修飾付きのイメージ名を使用することをおすすめします。

リリースを作成すると、Cloud Deploy は自動的にロールアウト リソースも作成し、1 つのターゲット prod にすぐにデプロイします。

安定フェーズにスキップする

この最初のリリースでは、カナリア フェーズをスキップして 100%（安定したフェーズ）までデプロイします。これは、アプリケーションが以前にデプロイされていないため、ポッドの 50% を計算する方法（GKE の場合）や、サービスに対するトラフィックを分割する方法（Cloud Run の場合）がないためです。Pod（GKE）またはリビジョン（Cloud Run）はまだ存在していません。

カナリア フェーズをスキップしたので、100% までのトラフィックを受信する、安定フェーズを開始する準備が整いました。その後、別のリリースを作成してカナリアを実行します。

実際の状況では、アプリケーションがすでに動作しているカナリア デプロイが実行されるため、このフェーズをスキップすることはまれです。

Google Cloud コンソールでリリースを表示する

これで最初のリリースを作成し、ロールアウトが作成されたため、Google Cloud コンソールでリリースとロールアウトを表示できます。可視化されたパイプラインを表示して、リリースの現在のステータスを確認することもできます。

1. Google Cloud コンソールで、Cloud Deploy の [デリバリー パイプライン] ページに移動し、my-canary-demo-app-1 デリバリー パイプラインを表示します。

   [デリバリー パイプライン] ページを開く

2. デリバリー パイプラインの名前「my-run-demo-app-1」をクリックします。

   可視化されたパイプラインでは、アプリのデプロイ ステータスが表示されます。パイプラインには 1 つのステージしかないため、可視化されたパイプラインにはノードが 1 つだけ表示されます。

   

   リリースが [デリバリー パイプラインの詳細] の下の [リリース] タブに表示されます。

3. リリース名 test-release-001 をクリックします。

   ロールアウトは [ロールアウト] に表示されます。ロールアウトをクリックすると、デプロイログなどの詳細を表示できます。

   

   ロールアウト ステータスが「Pending advance」になっており、可視化されたパイプラインに表示されているターゲットに「Advance to stable」へのリンクがあることに注目してください。

ロールアウト フェーズを進める

最初のリリースの後、カナリア フェーズはスキップされ、ロールアウトは「安定」フェーズの開始を待機しています。このフェーズにより、アプリケーションが 100% までデプロイされます。

1. 可視化されたパイプラインで、[Advance to stable] をクリックします。

2. プロンプトが表示されたら、[Advance] をクリックして確定します。

数分後、ロールアウトが「安定」フェーズになり、アプリケーションが 100% までデプロイされます。

カナリア デプロイを実行する

最初のリリースでカナリア フェーズをスキップしたため、別のリリースを作成し、今回はカナリア デプロイを実行します。

1. 新しい release を作成するには、deploy-canary-quickstart-gke、deploy-canary-quickstart-gke-gatewayapi、または deploy-canary-quickstart-run ディレクトリから次のコマンドを実行します。

   GKE

   gcloud deploy releases create test-release-002 \
     --project=PROJECT_ID \
     --region=us-central1 \
     --delivery-pipeline=my-canary-demo-app-1 \
     --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa
   

   GKE と Gateway API

   gcloud deploy releases create test-release-002 \
     --project=PROJECT_ID \
     --region=us-central1 \
     --delivery-pipeline=my-canary-demo-app-1 \
     --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa
   

   Cloud Run

   gcloud deploy releases create test-release-002 \
     --project=PROJECT_ID \
     --region=us-central1 \
     --delivery-pipeline=my-canary-demo-app-1 \
     --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4
   

   数分後、ロールアウトが作成され、今回はカナリア ステージが実行されます。

   

   最初のロールアウト フェーズが完了すると、ロールアウトはカナリア フェーズに入ります。

   

   これは、アプリケーションが現在 50% までデプロイされたことを示しています。serviceNetworking ベースの GKE の場合、Pod の半分までデプロイされます。Gateway API ベースの GKE と Cloud Run の場合、トラフィックは 50% まで割り当てられます。

2. [ロールアウトを進めます] をクリックし、プロンプトが表示されたら [進めます] をクリックします。

   これにより、ロールアウトが「安定」フェーズに進み、アプリケーションが 100% までデプロイされます。