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

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

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

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

GKE 接続クラスタでもデプロイ検証を使用できますが、このクイックスタートでは GKE と Cloud Run のみを使用します。
Cloud Deploy デリバリーパイプラインとデプロイターゲットを定義します。

デリバリーパイプラインには 1 つのステージのみが含まれ、1 つのターゲットのみが使用されます。デプロイ検証の構成は stage スタンザで定義します。
リリースに必要な Skaffold 構成と、Kubernetes マニフェストまたは Cloud Run サービス定義のいずれかを作成します。
リリースを作成します。リリースは自動的にターゲットにデプロイされます。

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

始める前に

Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

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

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Cloud Deploy、Cloud Build、GKE、Cloud Run、Cloud Storage API を有効にします。

API を有効にするために必要なロール

API を有効にするには、serviceusage.services.enable 権限を含む Service Usage 管理者 IAM ロール（roles/serviceusage.serviceUsageAdmin）が必要です。ロールを付与する方法を確認する。

API を有効にする

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

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

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Cloud Deploy、Cloud Build、GKE、Cloud Run、Cloud Storage API を有効にします。

API を有効にするために必要なロール

API を有効にする

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

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"

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

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

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

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

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

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

GKE

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

Cloud Run

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

デリバリーパイプラインとターゲット定義を作成：

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:
          tasks:
          - type: container
            image: ubuntu
            command: ["/bin/sh"]
            args: ["-c", 'echo "Your test or tests would go here."' ]
---

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:
          tasks:
          - type: container
            image: ubuntu
            command: ["/bin/sh"]
            args: ["-c", 'echo "Your test or tests would go here."' ]
---

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

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

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

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

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

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

Skaffold 構成ファイルとアプリケーションマニフェストを作成する

Cloud Deploy は Skaffold を使用して、サンプルアプリをターゲットにデプロイするために使用するマニフェストを特定します。

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

GKE

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

Cloud Run

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

この構成ファイルの詳細については、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 マニフェストであり、アプリケーションをデプロイするためにクラスタに適用されます。デプロイするコンテナイメージは、プレースホルダ my-app-image としてここに設定されます。このプレースホルダは、リリースを作成するときに特定のイメージに置き換えられます。
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 サービス定義であり、アプリケーションのデプロイに使用されます。デプロイするコンテナイメージは、プレースホルダ my-app-image としてここに設定されます。このプレースホルダは、リリースを作成するときに特定のイメージに置き換えられます。

リリースを作成する

リリースは 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

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

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:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

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

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

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

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 つだけ表示されます。

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

Verify がジョブとして表示されていることを確認します。
[確認] をクリックします。

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

textPayload に注目してください。この文字列は、デリバリーパイプラインの 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 ブラウザページを開く

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

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

始める前に

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

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

GKE

Cloud Run

GKE

Cloud Run

Skaffold 構成ファイルとアプリケーション マニフェストを作成する

GKE

Cloud Run

GKE

Cloud Run

リリースを作成する

GKE

Cloud Run

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

クリーンアップ

GKE

Cloud Run

次のステップ

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

Skaffold 構成ファイルとアプリケーションマニフェストを作成する