Google Kubernetes Engineへのデプロイ

継続的デプロイメント（CD）ワークフローの一部として、Google Kubernetes Engineへのデプロイを行えます。

この記事の内容

はじめに

このガイドは、main ブランチへのプッシュがある場合、GitHub Actions を使ってコンテナー化されたアプリケーションをビルドし、それを Google Container Registry (GCR) にプッシュし、Google Kubernetes Engine (GKE) にデプロイする方法を説明します。

GKEはGoogle CloudによるマネージドなKubernetesクラスタサービスで、コンテナ化されたワークロードをクラウドもしくはユーザ自身のデータセンターでホストできます。 詳細については、「Google Kubernetes Engine」を参照してください。

Note

GitHub Actions ワークフローが OpenID Connect (OIDC) をサポートするクラウド プロバイダーのリソースにアクセスする必要がある場合、そのクラウド プロバイダーで直接認証されるようにワークフローを構成できます。 これにより、有効期間の長いシークレットとしてこれらの資格情報の格納を停止し、その他のセキュリティ上の利点を提供できます。 詳しくは、「OpenID Connect を使ったセキュリティ強化について」をご覧ください

前提条件

ワークフローの作成に進む前に、Kubernetesプロジェクトについて以下のステップを完了しておく必要があります。 このガイドは、プロジェクトのルートに Dockerfile と Kubernetes Deployment 構成ファイルが既にあることを前提としています。

GKEクラスタの作成

GKE クラスターを作成するには、まず gcloud CLI を使用して認証する必要があります。 このステップに関する詳しい情報については、以下の記事を参照してください。

次に例を示します。

Shell
$ gcloud container clusters create $GKE_CLUSTER \
    --project=$GKE_PROJECT \
    --zone=$GKE_ZONE

APIの有効化

Kubernetes Engine及びContainer Registry APIを有効化してください。 次に例を示します。

Shell
$ gcloud services enable \
    containerregistry.googleapis.com \
    container.googleapis.com

サービスアカウントの設定と資格情報の保存

この手順は、GKEインテグレーション用のサービスアカウントの作成方法を示します。 アカウントを作成し、ロールを追加し、そのキーを取得し、GKE_SA_KEY という名前の、base64 でエンコードされた 暗号化された という名前のリポジトリ シークレットとして格納する方法について説明します。

  1. 新しいサービス アカウントを作成します。

    Shell
    gcloud iam service-accounts create $SA_NAME

  2. 作成したサービス アカウントのメール アドレスを取得します。

    Shell
    gcloud iam service-accounts list

  3. サービスアカウントにロールを追加してください。

    Note

    要件に合わせて、より制約の強いロールを適用してください。

    Shell
    gcloud projects add-iam-policy-binding $GKE_PROJECT \
  --member=serviceAccount:$SA_EMAIL \
  --role=roles/container.admin
gcloud projects add-iam-policy-binding $GKE_PROJECT \
  --member=serviceAccount:$SA_EMAIL \
  --role=roles/storage.admin
gcloud projects add-iam-policy-binding $GKE_PROJECT \
  --member=serviceAccount:$SA_EMAIL \
  --role=roles/container.clusterViewer

  4. サービス アカウントの JSON キーファイルをダウンロードします。

    Shell
    gcloud iam service-accounts keys create key.json --iam-account=$SA_EMAIL

  5. サービス アカウント キーを GKE_SA_KEY という名前のシークレットとして格納します。

    Shell
    export GKE_SA_KEY=$(cat key.json | base64)

    シークレットを格納する方法の詳細については、「GitHub Actions でのシークレットの使用」を参照してください。

プロジェクト名の保存

プロジェクトの名前を GKE_PROJECT という名前のシークレットとして保存します。 シークレットを格納する方法の詳細については、「GitHub Actions でのシークレットの使用」を参照してください。

（オプション）kustomizeの設定

Kustomizeは、YAML仕様を管理するために使われるオプションのツールです。 kustomization ファイルを作成した後、次のワークフローを使用して、イメージのフィールドを動的に設定し、結果を kubectl にパイプできます。 詳細については、「kustomize の使用」を参照してください。

(省略可能) デプロイ環境を構成する

環境は、一般的なデプロイ ターゲットを記述するために使用されます (例: production、staging、または development)。 GitHub Actions ワークフローが環境にデプロイされると、その環境がリポジトリのメイン ページに表示されます。 環境を使って、ジョブを進めるには承認を必須にすること、ワークフローをトリガーできるブランチを制限すること、カスタム デプロイ保護規則を使ってデプロイを制御すること、またはシークレットへのアクセスを制限することができます。 環境の作成の詳細については、「デプロイに環境の使用」を参照してください。

ワークフローの作成

必要な環境を整えたら、ワークフローの作成に進むことができます。

以下のワークフロー例は、コンテナイメージを作成して GCR にプッシュする方法を示しています。 次に、Kubernetes ツール (kubectl や kustomize など) を使用して、イメージがクラスター デプロイにプルされます。

env キーの下で、GKE_CLUSTER の値をクラスターの名前に、GKE_ZONE をクラスター ゾーンに、DEPLOYMENT_NAME をデプロイの名前に、IMAGE をイメージの名前に変更します。

デプロイ環境を構成した場合は、environment の値を環境の名前に変更します。 環境を構成しなかった場合、またはワークフローがプライベート リポジトリにあり、GitHub Enterprise Cloud を使わない場合は、environment キーを削除します。

YAML
# このワークフローはGitHubによって認定されていないアクションを使用します。
# それらはサードパーティによって提供され、
# 別個の利用規約、プライバシーポリシー、
# ドキュメントを参照してください。

# GitHub では、コミット SHA にアクションをピン留めすることが推奨されます。
# 新しいバージョンを取得するには、SHA を更新する必要があります。
# タグまたはブランチを参照することもできますが、アクションは警告なしに変更される可能性があります。

name: Build and Deploy to GKE

on:
  push:
    branches:
      - main

env:
  PROJECT_ID: ${{ secrets.GKE_PROJECT }}
  GKE_CLUSTER: cluster-1    # Add your cluster name here.
  GKE_ZONE: us-central1-c   # Add your cluster zone here.
  DEPLOYMENT_NAME: gke-test # Add your deployment name here.
  IMAGE: static-site

jobs:
  setup-build-publish-deploy:
    name: Setup, Build, Publish, and Deploy
    runs-on: ubuntu-latest
    environment: production

    steps:
    - name: Checkout
      uses: actions/checkout@v4

    # Setup gcloud CLI
    - uses: google-github-actions/setup-gcloud@1bee7de035d65ec5da40a31f8589e240eba8fde5
      with:
        service_account_key: ${{ secrets.GKE_SA_KEY }}
        project_id: ${{ secrets.GKE_PROJECT }}

    # Configure Docker to use the gcloud command-line tool as a credential
    # helper for authentication
    - run: |-
        gcloud --quiet auth configure-docker

    # Get the GKE credentials so we can deploy to the cluster
    - uses: google-github-actions/get-gke-credentials@db150f2cc60d1716e61922b832eae71d2a45938f
      with:
        cluster_name: ${{ env.GKE_CLUSTER }}
        location: ${{ env.GKE_ZONE }}
        credentials: ${{ secrets.GKE_SA_KEY }}

    # Build the Docker image
    - name: Build
      run: |-
        docker build \
          --tag "gcr.io/$PROJECT_ID/$IMAGE:$GITHUB_SHA" \
          --build-arg GITHUB_SHA="$GITHUB_SHA" \
          --build-arg GITHUB_REF="$GITHUB_REF" \
          .

    # Push the Docker image to Google Container Registry
    - name: Publish
      run: |-
        docker push "gcr.io/$PROJECT_ID/$IMAGE:$GITHUB_SHA"

    # Set up kustomize
    - name: Set up Kustomize
      run: |-
        curl -sfLo kustomize https://github.com/kubernetes-sigs/kustomize/releases/download/v3.1.0/kustomize_3.1.0_linux_amd64
        chmod u+x ./kustomize

    # Deploy the Docker image to the GKE cluster
    - name: Deploy
      run: |-
        ./kustomize edit set image gcr.io/PROJECT_ID/IMAGE:TAG=gcr.io/$PROJECT_ID/$IMAGE:$GITHUB_SHA
        ./kustomize build . | kubectl apply -f -
        kubectl rollout status deployment/$DEPLOYMENT_NAME
        kubectl get services -o wide

その他のリソース

これらの例で使用されているツールの詳細については、次のドキュメントを参照してください。