デプロイ後にアプリケーションを確認する

このクイックスタートでは、Cloud Deploy を使用して、デリバリーパイプラインの一部としてデプロイされたアプリケーションを確認する方法について説明します。

このクイックスタートでは、以下の内容を行います。

GKE クラスタを 1 つ、または Cloud Run サービスを 1 つ作成します。

GKE Enterprise クラスタでもデプロイ検証を使用できますが、このクイックスタートでは GKE と Cloud Run のみを使用します。
Skaffold 構成および、Kubernetes マニフェストまたは Cloud Run サービス定義のいずれかを作成します。

Skaffold 構成ファイルは、デプロイ後に実行するデプロイ検証コンテナを構成する場所です。
Cloud Deploy デリバリーパイプラインとデプロイターゲットを定義します。

デリバリーパイプラインの構成では、skaffold.yaml で定義したデプロイ検証を参照し、その検証を実行します。

このパイプラインには 1 つのステージのみが含まれ、1 つのターゲットのみが使用されます。
ターゲットに自動的にデプロイするリリースを作成します。

アプリケーションがデプロイされると、ロールアウトのフェーズとして検証が実行されます。
Google Cloud コンソールの Cloud Deploy の [ロールアウトの詳細] ページで、Cloud Build のログの検証結果を表示します。

準備

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

Enable the APIs

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

Enable the APIs

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

CLI がすでにインストールされている場合は、最新バージョンを実行していることを確認してください。

gcloud components update

デフォルトの Compute Engine サービスアカウントに十分な権限があることを確認します。
このサービスアカウントにはすでに必要な権限が付与されている場合があります。これらの手順は、デフォルトのサービスアカウントの自動的なロール付与を無効にするプロジェクトに含まれています。

最初に、clouddeploy.jobRunner ロールを追加します。

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/clouddeploy.jobRunner"

特定のランタイム向けのデベロッパーロールを追加します。

GKE の場合:

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/container.developer"

Cloud Run の場合:

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/run.developer"

ランタイムにデプロイする actAs 権限を含む iam.serviceAccountUser ロールを追加します。

gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/iam.serviceAccountUser" \
    --project=PROJECT_ID

ランタイム環境を作成する

Cloud Run にデプロイする場合は、以下のコマンドをスキップできます。

GKE の場合は、デフォルト設定で 1 つのクラスタ deploy-verification-cluster を作成します。クラスタの Kubernetes API エンドポイントは、公共のインターネットからネットワークに到達可能である必要があります。GKE クラスタには、デフォルトで外部からアクセス可能です。

gcloud container clusters create-auto deploy-verification-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

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

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

このクイックスタートでは、skaffold.yaml ファイルを作成します。このファイルは、サンプルアプリのデプロイに使用するマニフェストと、デプロイ後に実行するコンテナ（デプロイ検証）を識別します。

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

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

GKE

mkdir deploy-verification-gke-quickstart
cd deploy-verification-gke-quickstart

Cloud Run

mkdir deploy-verification-run-quickstart
cd deploy-verification-run-quickstart

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

GKE

apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - k8s-pod.yaml
deploy:
  kubectl: {}
verify:
- name: verification-test
  container:
    name: verification-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "Your test or tests would go here."' ]

Cloud Run

apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}
verify:
- name: verification-test
  container:
    name: verification-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "Your test or tests would go here."' ]

このファイルには、verify: スタンザが含まれており、アプリケーションのデプロイ後に実行するコンテナとコマンドを定義します。この場合は、Ubuntu コンテナをデプロイし、単純な echo コマンドを実行します。このコマンドの結果はログで確認できます。より現実的なシナリオでは、デプロイしたアプリケーションに対してテストを実行します。

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

アプリケーションの定義（Cloud Run のサービス定義、または GKE の Kubernetes マニフェスト）を作成します。
GKE
次の内容のファイルを k8s-pod.yaml という名前で作成します。
```
apiVersion: v1
kind: Pod
metadata:
  name: my-verification-pod
spec:
  containers:
  - name: nginx
    image: my-app-image
```
このファイルは、単純な Kubernetes マニフェストであり、アプリケーションをデプロイするためにクラスタに適用されます。
Cloud Run
次の内容のファイルを service.yaml という名前で作成します。
```
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: my-verification-run-service
spec:
  template:
    spec:
      containers:
      - image: my-app-image
```
このファイルは単純な Cloud Run サービス定義であり、デプロイ時に Cloud Run サービスを作成するために使用されます。

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

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

デリバリーパイプラインとターゲットの定義を作成します。

GKE

deploy-verification-gke-quickstart ディレクトリに、次の内容を含む新しい clouddeploy.yaml ファイルを作成します。

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-verification-demo-app-gke-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: verify-staging
    profiles: []
    strategy:
      standard:
        verify: true
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: verify-staging
description: verification staging cluster
gke:
  cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-verification-cluster

Cloud Run

deploy-verification-run-quickstart ディレクトリに、次の内容を含む新しい clouddeploy.yaml ファイルを作成します。

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-verification-demo-app-run-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: verify-staging
    profiles: []
    strategy:
      standard:
        verify: true
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: verify-staging
description: staging Run service
run:
  location: projects/PROJECT_ID/locations/us-central1

パイプラインとターゲットを Cloud Deploy サービスに登録します。
```
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
```
これで、1 つのターゲットを含むデリバリーパイプラインが用意され、アプリケーションをデプロイしてデプロイを検証する準備が整いました。
パイプラインとターゲットを確認します。

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

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

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

リリースを作成する

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

GKE

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

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

Cloud Run

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

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

すべてのリリース（--disable-initial-rollout を含むものを除き）において、Cloud Deploy ではロールアウトリソースも自動的に作成されます。アプリケーションは、このデリバリーパイプライン用に構成された 1 つのターゲットに自動的にデプロイされます。

Skaffold 構成で指定した検証ジョブは、アプリケーションのデプロイ後に、このロールアウトの一部として実行されます。

Google Cloud コンソールで結果を表示する

数分後、リリースがターゲットランタイムにデプロイされます。

例として、構成した確認ジョブなどにより、Cloud Build ログに文字列が出力されます。このログを表示して、検証が想定どおりに機能することを確認できます。

Google Cloud コンソールで、Cloud Deploy の [デリバリーパイプライン] ページに移動し、デリバリーパイプライン（「deploy-verification-demo-app-gke-1」または「deploy-verification-demo-app-run-1」）を表示します。

[デリバリーパイプライン] ページを開く
デリバリーパイプラインの名前（「deploy-verification-demo-app-gke-1」または「deploy-verification-demo-app-run-1」）をクリックします。

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

リリースが [デリバリーパイプラインの詳細] の下の [リリース] タブに表示されます。
[デリバリーパイプラインの詳細] で [ロールアウト] タブをクリックします。
ロールアウト名をクリックして、ロールアウトの詳細を表示します。

[確認] はジョブとして表示されます。
[確認] をクリックします。

ジョブ実行ログが表示されます。
ログエントリのリストを下にスクロールして、verification-test を見つけて、それをクリックします。

textPayload に注目してください。この文字列は、Skaffold 構成の Verify スタンザで構成されたものです。

クリーンアップ

このページで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、次の手順を行います。

GKE クラスタまたは Cloud Run サービスを削除します。

GKE

gcloud container clusters delete deploy-verification-cluster --region=us-central1 --project=PROJECT_ID

Cloud Run

gcloud run services delete my-verification-run-service --region=us-central1 --project=PROJECT_ID

デリバリーパイプライン、ターゲット、リリース、ロールアウトを削除します。
```
gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
```
Cloud Deploy によって作成された Cloud Storage バケットを削除します。

1 つは _clouddeploy で終わり、もう 1 つは [region].deploy-artifacts.[project].appspot.com で終わります。

Cloud Storage ブラウザページを開く

これでクイックスタートの演習はすべて終了です。

デプロイ後にアプリケーションを確認する

準備

ランタイム環境を作成する

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

GKE

Cloud Run

GKE

Cloud Run

GKE

Cloud Run

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

GKE

Cloud Run

リリースを作成する

GKE

Cloud Run

Google Cloud コンソールで結果を表示する

クリーンアップ

GKE

Cloud Run

次のステップ

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

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