デプロイパラメータを使用する

このページでは、Cloud Deploy を使用して、それぞれのレンダリングされたマニフェストまたはサービス定義に異なる 3 つの方法を使用して異なるパラメータ値を渡し、サンプルアプリケーションを 2 つのターゲットに同時に配信する（並列デプロイ）方法を説明します。

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

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

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

マニフェストまたはサービス定義は両方の子ターゲットで同じですが、デプロイ時に、このクイックスタートで構成された特定のパラメータに対して、子ターゲットごとにレンダリングされたマニフェストまたはサービスの定義には異なる値が設定されます。
Cloud Deploy デリバリーパイプラインとデプロイターゲットを定義します。

このパイプラインには、アプリを 2 つのクラスタまたは 2 つのサービスに配信する 2 つの子ターゲットを参照するマルチターゲットがあります。
デプロイパラメータを次の 3 か所に定義します。
- パイプラインの進行中に
- 子ターゲットで
- リリースの作成時にコマンドラインで
リリースを作成してデリバリーパイプラインをインスタンス化します。リリースは自動的に 2 つのターゲットに並行してデプロイされます。
Google Cloud コンソールで「コントローラのロールアウト」と子のロールアウトを表示します。

始める前に

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

gcloud container clusters create-auto deploy-params-cluster-prod1 \
                 --project=PROJECT_ID \
                 --region=us-central1 \
                 && gcloud container clusters create-auto deploy-params-cluster-prod2 \
                 --project=PROJECT_ID \
                 --region=us-west1

Skaffold 構成とマニフェストを準備する

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

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

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

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

GKE

mkdir deploy-params-gke-quickstart
cd deploy-params-gke-quickstart

Cloud Run

mkdir deploy-params-run-quickstart
cd deploy-params-run-quickstart

次の内容のファイルを skaffold.yaml という名前で作成します。
GKE
```
apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - kubernetes.yaml
deploy:
  kubectl: {}
```
Cloud Run
```
apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}
```
このファイルは最小の Skaffold 構成ファイルです。このクイックスタートでは、このファイルを作成します。ただし、Cloud Deploy で作成することで、単純な非本番環境アプリケーション用に作成することもできます。

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

アプリケーションの定義（Cloud Run のサービス定義、または GKE の Kubernetes マニフェスト）を作成します。

GKE

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

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment
spec:
  replicas: 1 # from-param: ${replicaCount}
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
      annotations:
        commit: defaultShaValue # from-param: ${git-sha}
    spec:
      containers:
      - name: nginx
        image: my-app-image
        env:
        - name: envvar1
          value: default1 # from-param: ${application_env1}
        - name: envvar2
          value: default2 # from-param: ${application_env2}

このファイルは、単純な Kubernetes マニフェストであり、アプリケーションをデプロイするためにクラスタに適用されます。

Cloud Run

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

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: my-parallel-run-service
spec:
  autoscaling.knative.dev/minScale: 1 # from-param: ${minInstances}
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      annotations:
        commit: defaultShaValue # from-param: ${git-sha}
    spec:
      containers:
      - image: my-app-image
        env:
        - name: envvar1
          value: defaultValue1 # from-param: ${application_env1}
        - name: envvar2
          value: defaultValue2 # from-param: ${application_env2}

このファイルは単純な Cloud Run サービス定義であり、デプロイ時に Cloud Run サービスを作成するために使用されます。

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

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

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

GKE

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

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-params-demo-app-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: params-prod-multi
    deployParameters:
    - values:
        replicaCount: "2"
      matchTargetLabels:
        label1: label1
    - values:
        replicaCount: "3"
      matchTargetLabels:
        label2: label2
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: params-prod-multi
description: production clusters
multiTarget:
  targetIds: [params-prod-a, params-prod-b]
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: params-prod-a
  labels:
    label1: label1
description: production cluster 1
deployParameters:
  application_env1: "sampleValue1"
gke:
  cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-params-cluster-prod1
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: params-prod-b
  labels:
    label2: label2
description: production cluster 2
deployParameters:
  application_env2: "sampleValue2"
gke:
  cluster: projects/PROJECT_ID/locations/us-west1/clusters/deploy-params-cluster-prod2

Cloud Run

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

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-params-demo-app-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: params-prod-multi
    deployParameters:
    - values:
        minInstances: "2"
      matchTargetLabels:
        label1: label1
    - values:
        minInstances: "3"
      matchTargetLabels:
        label2: label2
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: params-prod-multi
description: production clusters
multiTarget:
  targetIds: [params-prod-a, params-prod-b]
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: params-prod-a
  labels:
    label1: label1
description: production cluster 1
deployParameters:
  application_env1: "sampleValue1"
run:
  location: projects/PROJECT_ID/locations/us-central1
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: params-prod-b
  labels:
    label2: label2
description: production cluster 2
deployParameters:
  application_env2: "sampleValue2"
run:
  location: projects/PROJECT_ID/locations/us-west1

パイプラインとターゲットを Cloud Deploy サービスに登録します。
```
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
```
これで、2 つの GKE ターゲットまたは Cloud Run ターゲットから成るマルチターゲットを有するパイプラインが作成されました。これで、アプリケーションをデプロイする準備が整いました。
パイプラインとターゲットを確認します。

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

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

作成したデリバリーパイプラインが表示されます。clouddeploy.yaml ファイルで 3 つのターゲット（1 つのマルチターゲットと 2 つの子ターゲット）を構成している場合でも、[ターゲット] 列に 1 つのターゲットが表示されます。

リストにあるターゲットはマルチターゲット params-prod-multi のみです。子ターゲットは表示されません。

リリースを作成する

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

GKE

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

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

Cloud Run

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

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

通常どおり、リリースを作成すると、パイプラインの最初のターゲット（この場合は --to-target= を使用して指定された特定のターゲット）のロールアウトが自動的に作成されます。このクイックスタートでは、このターゲットはマルチターゲットです。そのため、rollout は 2 つの子ターゲットの「コントローラロールアウト」であり、デリバリーパイプラインには後続のターゲットはありません。つまり、ロールアウトが作成されるたびにアプリケーションがデプロイされます。

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

リリースの作成が完了し、コントローラのロールアウトと子ロールアウトが作成されたので、それらの子ロールアウトはそれぞれの GKE クラスタまたは Cloud Run サービスにデプロイされ（またはすでにデプロイ処理中）ます。

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

[デリバリーパイプライン] ページを開く
デリバリーパイプラインの名前「my-parallel-demo-app-1」をクリックします。

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

リリースが [デリバリーパイプラインの詳細] の下の [リリース] タブに表示されます。
リリース名 test-release-001 をクリックします。

ロールアウトが [ロールアウト] に表示されます。ロールアウトをクリックすると、デプロイログなどの詳細を表示できます。
[リリースの詳細] で [アーティファクト] タブを選択します。

[デプロイパラメータ] 表に、マニフェストで構成したすべてのパラメータと、それらのパラメータに指定した値が表示されます。

GKE

Cloud Run

この表には、パラメータと値だけでなく、各パラメータが適用されるターゲットも示されます。
[リリースインスペクタ] 列で、いずれかのターゲットの [アーティファクトを表示] をクリックします。
[差分を表示] をクリックし、1 つのターゲットに params-prod-a を選択し、もう 1 つのターゲットに params-prod-b を選択します。

差分が表示され、指定した値を含む 2 つのターゲットのレンダリングされたマニフェストを比較します。

GKE

Cloud Run

クリーンアップ

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

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

GKE

gcloud container clusters delete deploy-params-cluster-prod1 --region=us-central1 --project=PROJECT_ID \
&& gcloud container clusters delete deploy-params-cluster-prod2 --region=us-west1 --project=PROJECT_ID

Cloud Run

gcloud run services delete my-parallel-run-service --region=us-central1 --project=PROJECT_ID \
&& gcloud run services delete my-parallel-run-service --region=us-west1 --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 ブラウザページを開く

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

次のステップ

デプロイパラメータの使用について詳細を確認する。
複数のターゲットに同時にデプロイする方法については、こちらをご覧ください。
Cloud Deploy の詳細
アプリケーションのデプロイの基本を学習する。
Cloud Deploy のチュートリアルを試す。
マニフェストを管理する方法を確認する。
Google Cloud CI / CD ツールを組み合わせてソフトウェアを効果的に開発し、GKE に提供する方法を確認する。

デプロイ パラメータを使用する

始める前に

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

Skaffold 構成とマニフェストを準備する

GKE

Cloud Run

GKE

Cloud Run

GKE

Cloud Run

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

GKE

Cloud Run

リリースを作成する

GKE

Cloud Run

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

GKE

Cloud Run

GKE

Cloud Run

クリーンアップ

GKE

Cloud Run

次のステップ

デプロイパラメータを使用する

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