GithubとCloud Buildを使ったCloud RunのCI/CD環境構築（Kanikoキャッシュ使用）

# cloudbuild.yaml
# Google Cloud Buildの設定ファイルです。
# このファイルはDockerイメージをビルドし、
# GCRにプッシュしてCloud Runにデプロイするために使用されます。

substitutions:
	_LOCATION: <Artifact Registryのロケーション>
	_REPOSITORY: <Artifact Registryの名前>
  _IMAGE_NAME: <作成されるDockerイメージの名前>
  _TAG: <作成されるDockerイメージのタグ>
  _SERVICE_NAME: <Cloud Runにデプロイされるアプリケーションの名前>
  _REGION: <Cloud Runのリージョン>
  
steps:
  # ステップ 1: Kanikoを使用してDockerイメージをビルドして、リポジトリにPushする
  - name: 'gcr.io/kaniko-project/executor:latest'
    args:
    - --destination=${_LOCATION}-docker.pkg.dev/${PROJECT_ID}/${_REPOSITORY}/${_IMAGE_NAME}:${_TAG}
    - --dockerfile=<GitHub上でのDockerfileのパス>
    - --cache=true
    - --cache-ttl=8h
    - --compressed-caching=false
    - --cache-copy-layers=true
    id: Build & Push

  # ステップ 2: Cloud Runにデプロイする
  - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
    entrypoint: 'gcloud'
    args: ['run', 'deploy', '${_SERVICE_NAME}', 
           '--image', '${_LOCATION}-docker.pkg.dev/${PROJECT_ID}/${_REPOSITORY}/${_IMAGE_NAME}:${_TAG}', 
           '--region', '${_REGION}',
           '--platform', 'managed',
           '--allow-unauthenticated',
           '--memory', '2Gi',
           '--concurrency', '1',
           ]
    id: Deploy

変数の設定

substitutions:
	_LOCATION: <Artifact Registryのロケーション>
	_REPOSITORY: <Artifact Registryの名前>
  _IMAGE_NAME: <作成されるDockerイメージの名前>
  _TAG: <作成されるDockerイメージのタグ>
  _SERVICE_NAME: <Cloud Runにデプロイされるアプリケーションの名前>
  _REGION: <Cloud Runのリージョン>

上記のような内容については変数化しておくと、変更があった場合に便利です。

PROJECT_IDについてはデフォルトで設定されているので、特に指定しません。

Cloud Buildの変数に関する詳しい説明は以下をご覧ください。

変数値の置換 | Cloud Build Documentation | Google Cloud

Use default substitutions or define your own substitutions.

https://cloud.google.com

Dockerイメージのビルドとプッシュ

	- name: 'gcr.io/kaniko-project/executor:latest'
    args:
    - --destination=${_LOCATION}-docker.pkg.dev/${PROJECT_ID}/${_REPOSITORY}/${_IMAGE_NAME}:${_TAG}
    - --dockerfile=<GitHub上でのDockerfileのパス>
    - --cache=true
    - --cache-ttl=8h
    - --compressed-caching=false
    - --cache-copy-layers=true
    id: Build & Push

Dockerイメージのビルドとプッシュの記述について説明します。

name: 使用するビルドツールとしてgcr.io/kaniko-project/executor:latestを指定。
args:
- destination: 作成したイメージの保存先を指定。
  - ${_LOCATION}-docker.pkg.dev/${PROJECT_ID}/${_REPOSITORY}/${_IMAGE_NAME}:${_TAG}形式で指定。
- dockerfile: 使用するDockerfileのパスを指定。
- cache=true: キャッシュを有効にしてビルドを高速化。
- cache-ttl=8h: キャッシュの有効期限を8時間に設定。任意の時間に変更可
- compressed-caching=false: 圧縮キャッシングを無効に。
- cache-copy-layers=true: キャッシュコピーのレイヤーを有効に。

上記のargs以外にも指定できるものが数多くあります。詳細については以下をご覧ください。

GitHub - GoogleContainerTools/kaniko: Build Container Images In Kubernetes

Build Container Images In Kubernetes. Contribute to GoogleContainerTools/kaniko development by creating an account on GitHub.

https://github.com

💡

ポイント

ビルド対象のDockerfileの記述において、さまざまなライブラリをインストールすると思います。

その時に、requirements.txtに必要なライブラリ名とバージョンを記述して、RUN pip install -r requirements.txt のようにインストールする手法がありますが、私の場合はキャッシュ化されませんでした。

もし、Kanikoキャッシュを使ってもビルド時間が短縮されないようなことがあれば、ライブラリのインストール部分をべた書きにする対策があることを覚えておいてください。

Cloud Runのアプリケーションのデプロイ

  - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
    entrypoint: 'gcloud'
    args: ['run', 'deploy', '${_SERVICE_NAME}', 
           '--image', '${_LOCATION}-docker.pkg.dev/${PROJECT_ID}/${_REPOSITORY}/${_IMAGE_NAME}:${_TAG}', 
           '--region', '${_REGION}'
           ]
    id: Deploy

Cloud Runのアプリケーションのデプロイの記述について説明します。

name: 使用するデプロイツールとしてgcr.io/google.com/cloudsdktool/cloud-sdkを指定。
entrypoint: gcloudコマンドを使用。
args:
- run deploy: Cloud Runにアプリケーションをデプロイするコマンド。
- ${_SERVICE_NAME}: デプロイするサービスの名前。
- -image: デプロイするDockerイメージの場所を指定。
- -region: Cloud Runのリージョンを指定。

上記のargs以外にも指定できるものが数多くあります。詳細については以下をご覧ください。

Cloud Build を使用した Cloud Run へのデプロイ | Cloud Build Documentation | Google Cloud

https://cloud.google.com

5. Cloud Buildトリガーの作成

cloudbuild.yamlを作成したところで、GitHubの特定のリポジトリのブランチにプッシュされたときに、cloudbuild.yamlを参照してCloud Runへアプリケーションを自動でデプロイするように、Cloud Buildのトリガーを設定します。

Google Cloud ConsoleのCloud Buildプロダクトのページのトリガーのページに移動します。

トリガーを作成を押します。

名前は任意、リージョンは「asia-east1（台湾）」、イベントは「ブランチにpushする」を設定します。

リージョンを台湾にした理由としては、Cloud Buildの仕様に使用状況に応じて、特定のリージョンしか使えなくなるものがあったためです。
詳しくは以下をご覧ください。

Cloud Build のロケーション | Cloud Build Documentation | Google Cloud

https://cloud.google.com