# 部署到 Google Kubernetes Engine

了解如何在持续部署 (CD) 工作流中将项目部署到 Google Kubernetes Engine (GKE)。

## 先决条件

在继续创建工作流程之前，您需要完成 Kubernetes 项目的以下步骤。 本指南假定项目的根目录已有 `Dockerfile` 和 Kubernetes 部署配置文件。

### 创建 GKE 群集

要创建 GKE 群集，首先需要使用 `gcloud` CLI 进行身份验证。 有关此步骤的更多信息，请参阅以下文章：

* [`gcloud auth login`](https://cloud.google.com/sdk/gcloud/reference/auth/login)
* [
  `gcloud`CLI（命令行界面）](https://cloud.google.com/sdk/gcloud/reference)
* [
  `gcloud` CLI 和 Cloud SDK](https://cloud.google.com/sdk/gcloud#the_gcloud_cli_and_cloud_sdk)

例如：

```shell copy
$ gcloud container clusters create $GKE_CLUSTER \
    --project=$GKE_PROJECT \
    --zone=$GKE_ZONE
```

### 启用 API

启用 Kubernetes Engine 和 Container Registry API。 例如：

```shell copy
$ gcloud services enable \
    containerregistry.googleapis.com \
    container.googleapis.com
```

### 配置服务帐户并存储其凭据

此程序显示如何为您的 GKE 集成创建服务帐户。 它介绍如何创建帐户、向其添加角色、检索其密钥并将其存储为 base64 编码的 加密 存储库机密 `GKE_SA_KEY`。

1. 创建新服务帐户：

   ```shell copy
   gcloud iam service-accounts create $SA_NAME
   ```

2. 检索你刚刚创建的服务帐户的电子邮件地址：

   ```shell copy
   gcloud iam service-accounts list
   ```

3. 向服务帐户添加角色。

   > \[!NOTE]
   > 使用更严格限制的角色以满足你的要求。

   ```shell copy
   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 copy
   gcloud iam service-accounts keys create key.json --iam-account=$SA_EMAIL
   ```

5. 将服务帐户密钥存储为名为 `GKE_SA_KEY` 的机密：

   ```shell copy
   export GKE_SA_KEY=$(cat key.json | base64)
   ```

   有关如何存储机密的详细信息，请参阅“[在 GitHub Actions 中使用机密](/zh/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets)”。

### 存储项目名称

将项目的名称存储为名为 `GKE_PROJECT` 的机密。 有关如何存储机密的详细信息，请参阅“[在 GitHub Actions 中使用机密](/zh/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets)”。

### （可选）配置 kustomize

Kustomize 是用于管理 YAML 规范的可选工具。 在创建 `kustomization` 文件之后， 下面的工作流可用于将结果中的图像和管道字段动态设置为 `kubectl`。 有关详细信息，请参阅 [Kustomize 用法](https://github.com/kubernetes-sigs/kustomize#usage)。

### （可选）配置部署环境

环境用于描述常规部署目标，例如 `production`、`staging` 或 `development`。
GitHub Actions当工作流部署到环境时，环境将显示在存储库的主页上。 可以使用环境来要求审批作业以继续，限制可以触发工作流的分支，使用自定义部署保护规则控制部署，或限制对机密的访问权限。 有关创建环境的详细信息，请参阅“[管理部署环境](/zh/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments)”。

## 创建工作流程

完成先决条件后，可以继续创建工作流程。

下面的示例工作流程演示如何生成容器映像并推送到 GCR。 然后，它使用 Kubernetes 工具（如 `kubectl` 和 `kustomize`）将映像拉取入群集部署。

在 `env` 密钥下，将值 `GKE_CLUSTER` 更改为群集的名称，将 `GKE_ZONE` 更改为群集区域，将 `DEPLOYMENT_NAME` 更改为部署的名称以及将 `IMAGE` 更改为映像的名称。

如果配置了部署环境，请将 `environment` 的值更改为环境的名称。 如果未配置环境 ，或者如果工作流位于专用存储库中并且你未使用 GitHub Enterprise Cloud，请删除 `environment` 密钥。

```yaml copy
# 此工作流使用未经 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@v6

    # 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
```

## 其他阅读材料

有关这些示例中使用的工具的详细信息，请参阅以下文档：

* 有关完整的工作流模板，请参阅[“生成并部署到 GKE”工作流](https://github.com/actions/starter-workflows/blob/main/deployments/google.yml)。
* Kubernetes YAML 自定义引擎：[Kustomize](https://kustomize.io/)。
* Google Kubernetes Engine 文档中的“[部署容器化 Web 应用](https://cloud.google.com/kubernetes-engine/docs/tutorials/hello-app)”。