カスタムターゲットタイプを定義して使用する

このクイックスタートでは、Cloud Deploy を使用してカスタムターゲットタイプを作成し、そのタイプをカスタムターゲットにデプロイする方法について説明します。

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

Skaffold 構成を作成します。

Skaffold 構成ファイルでは、ターゲットの動作を構成します。この構成では、コンテナイメージと、それらのイメージで実行するシェルコマンドが参照されます。これらのコマンドは、レンダリングとデプロイオペレーションのためのアクションです。
カスタムターゲットタイプと、そのタイプを参照するターゲットを定義します。
Cloud Deploy デリバリーパイプラインを定義します。

このパイプラインには 1 つのステージのみが含まれ、1 つのターゲットのみが使用されます。この段階で、構成したターゲットを参照します。
リリースを作成します。これにより、自動的にロールアウトが作成され、カスタムレンダリングとデプロイのオペレーションが実行されます。

このリリースとロールアウトの一環として、Skaffold 構成で定義されたレンダリングとデプロイのオペレーションが両方とも実行されます。
カスタムオペレーションの結果を表示します。これには、Cloud Storage にアップロードされたレンダリング済みの構成ファイル、そのファイルに書き込まれた文字列、オペレーションのステータスを含む結果ファイルが含まれます。

準備

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

Google Cloud 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"

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

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

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

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

このクイックスタートでは、skaffold.yaml ファイルを作成します。このファイルは、カスタムターゲットタイプのレンダリングとデプロイのオペレーションを表すカスタムアクションを定義します。

このクイックスタートで提供されるカスタムアクションでは、実際にはアプリケーションがランタイムにデプロイされません。このレンダリングとデプロイのアクションでは両方とも、Cloud Storage に結果ファイルをアップロードし、Cloud Deploy とユーザー定義のレンダリングとデプロイとの間のカスタムターゲット契約を履行します。

ターミナルウィンドウを開きます。
新しいディレクトリを作成し、そのディレクトリに移動します。
```
mkdir custom-target-quickstart
cd custom-target-quickstart
```

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

apiVersion: skaffold/v4beta7
kind: Config
customActions:
- name: custom-render
  containers:
  - name: render
    image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
    command: ['/bin/bash']
    args:
      - '-c'
      - |-
        echo "Sample manifest rendered content" > manifest.txt
        gcloud storage cp manifest.txt $CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt
        echo {\"resultStatus\": \"SUCCEEDED\", \"manifestFile\": \"$CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt\"} > results.json
        gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
- name: custom-deploy
  containers:
  - name: deploy
    image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
    command: ['/bin/bash']
    args:
      - '-c'
      - |-
        echo {\"resultStatus\": \"SUCCEEDED\"} > results.json
        gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json

このファイルには、カスタムレンダリングアクションとカスタムデプロイアクションを定義する customActions: スタンザが含まれています。これらの各カスタムアクションでは、実行するコンテナイメージと、そのコンテナ上で実行するコマンドが参照されます。

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

デリバリーパイプライン、カスタムターゲットタイプ、ターゲットを作成する

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

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

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: custom-targets-pipeline
serialPipeline:
  stages:
  - targetId: sample-env
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: sample-env
customTarget:
  customTargetType: basic-custom-target
---

apiVersion: deploy.cloud.google.com/v1
kind: CustomTargetType
metadata:
  name: basic-custom-target
customActions:
  renderAction: custom-render
  deployAction: custom-deploy

パイプラインとターゲットを Cloud Deploy サービスに登録します。
```
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
```
これで、1 つのデリバリーパイプラインと 1つのターゲットが作成されました。このターゲットはこのカスタムターゲットタイプを使用し、このパイプラインではアプリケーションがランタイムにデプロイされません。
次のとおりに、パイプラインとターゲットを確認します。

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

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

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

リリースを作成する

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

custom-target-quickstart ディレクトリから次のコマンドを実行して、デプロイするカスタムアクションを表す release リソースを作成します。

gcloud deploy releases create test-release-001 \
  --project=PROJECT_ID \
  --region=us-central1 \
  --delivery-pipeline=custom-targets-pipeline

すべてのリリース（--disable-initial-rollout を含むものを除き）において、Cloud Deploy ではロールアウトリソースも自動的に作成されます。レンダリングとデプロイを含む、ロールアウトのすべてのフェーズが実行されます。

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

数分後、デプロイが完了します。この場合、2 つのカスタムアクションは文字列をファイルにエコーしてそのファイルを Cloud Storage にアップロードするコマンドであるため、ターゲットランタイムには何もデプロイされません。

ただし、次のように、ファイルとそのファイル内の文字列は表示できます。

Google Cloud コンソールで、Cloud Deploy の [デリバリーパイプライン] ページに移動し、デリバリーパイプライン（custom-targets-pipeline）を表示します。

[デリバリーパイプライン] ページを開く
デリバリーパイプラインの名前（custom-targets-pipeline）をクリックします。

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

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

[リリースの詳細] ページが表示されます。
[アーティファクト] タブをクリックします。
[ターゲットのアーティファクト] で、[アーティファクトを表示] リンクをクリックします。

レンダリングされたマニフェストファイルが表示されます。この場合、このファイルは skaffold.yaml 構成ファイルで定義したカスタムレンダリングアクションの出力であり、「サンプルのレンダリングされたマニフェストのコンテンツ」が含まれています。
このリリースによって作成された Cloud Storage バケットを確認します。
Cloud Storage ブラウザページを開く

[バケット] ページが表示され、このリリース用に作成された 2 つのバケットが表示されます。1 つのバケットには、デリバリーパイプラインの構成ファイルとレンダリングされた skaffold.yaml が含まれています。もう 1 つは、カスタムアクションを作成するように構成された出力ファイルです。
名前が us-central1.deploy-artifacts... で始まるバケットをクリックします
名前が custom-targets-pipeline- で始まるフォルダをクリックし、test-release-001 フォルダをクリックします。
ロールアウト名になっているフォルダをクリックします（test-release-001-to-sample-env-0001）。
表示されたフォルダ（UUID）をクリックして custom-output フォルダをクリックします。
results.json をクリックし、[認証済み URL] フィールドのハイパーリンク付き URL をクリックします。

このファイルでは、custom-deploy アクションの出力として構成した文字列が skaffold.yaml に含まれています。

クリーンアップ

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

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

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

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

カスタム ターゲット タイプを定義して使用する

準備

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

デリバリー パイプライン、カスタム ターゲット タイプ、ターゲットを作成する