使用 Cloud Build，以 GitOps 模式持續推送軟體更新

在 Cloud Source Repositories 中建立 Git 存放區

在本節中，您將建立本教學課程中使用的兩個 Git 存放區 (「app」和「env」)，並使用一些範例程式碼來初始化「app」存放區。

1. 在 Cloud Shell 中，建立兩個 Git 存放區。

   gcloud source repos create hello-cloudbuild-app
   gcloud source repos create hello-cloudbuild-env
   

2. 從 GitHub 複製範例程式碼。

   cd ~
   git clone https://github.com/GoogleCloudPlatform/kubernetes-engine-samples
   cd ~/kubernetes-engine-samples/management/gitops-style-delivery/
   

3. 將 Cloud Source Repositories 設定為遠端。

   PROJECT_ID=$(gcloud config get-value project)
   git remote add google \
       "https://source.developers.google.com/p/${PROJECT_ID}/r/hello-cloudbuild-app"
   

您複製的程式碼包含「Hello World」應用程式。

from flask import Flask
app = Flask('hello-cloudbuild')

@app.route('/')
def hello():
  return "Hello World!\n"

if __name__ == '__main__':
  app.run(host = '0.0.0.0', port = 8080)

使用 Cloud Build 建立容器映像檔

複製的程式碼包含下列 Dockerfile。

FROM python:3.13-slim
RUN pip install flask
WORKDIR /app
COPY app.py /app/app.py
ENTRYPOINT ["python"]
CMD ["/app/app.py"]

使用此 Dockerfile，您可以使用 Cloud Build 建立容器映像檔，並將其儲存在 Artifact Registry 中。

1. 在 Cloud Shell 中，使用以下指令建立以最新修訂版本為基礎的 Cloud Build 建構作業。

   cd ~/kubernetes-engine-samples/management/gitops-style-delivery/
   COMMIT_ID="$(git rev-parse --short=7 HEAD)"
   gcloud builds submit --tag="us-central1-docker.pkg.dev/${PROJECT_ID}/my-repository/hello-cloudbuild:${COMMIT_ID}" .
   

   執行此指令時，Cloud Build 會將建立容器映像檔產生的記錄串流到您的終端機。

2. 建構完成後，請確認您的新容器映像檔確實存在於 Artifact Registry 中。

   前往 Artifact Registry

   

建立持續整合管道

在本節中，您會將 Cloud Build 設定為自動執行小型單元測試、建構容器映像檔，然後將其推送到 Artifact Registry。將新修訂版本推送到 Cloud Source Repositories 會自動觸發此管道。程式碼中的 cloudbuild.yaml 檔案是管道的設定。

steps:
# This step runs the unit tests on the app
- name: 'python:3.13-slim'
  id: Test
  entrypoint: /bin/sh
  args:
  - -c
  - 'pip install flask && python test_app.py -v'

# This step builds the container image.
- name: 'gcr.io/cloud-builders/docker'
  id: Build
  args:
  - 'build'
  - '-t'
  - 'us-central1-docker.pkg.dev/$PROJECT_ID/my-repository/hello-cloudbuild:$SHORT_SHA'
  - '.'

# This step pushes the image to Artifact Registry
# The PROJECT_ID and SHORT_SHA variables are automatically
# replaced by Cloud Build.
- name: 'gcr.io/cloud-builders/docker'
  id: Push
  args:
  - 'push'
  - 'us-central1-docker.pkg.dev/$PROJECT_ID/my-repository/hello-cloudbuild:$SHORT_SHA'

1. 開啟 Cloud Build 的「Triggers」(觸發條件) 頁面。

   前往「Triggers」(觸發條件)

2. 按一下「建立觸發條件」。

3. 填寫下列選項：

   • 在「Name」(名稱) 欄位中輸入 hello-cloudbuild。
   • 在「事件」下方，選取「推送至分支版本」。
   • 在「來源」下方，將「存放區」設為 hello-cloudbuild-app，並將「分支版本」設為 ^master$。
   • 在「建構設定」下方，選取「Cloud Build 設定檔」。
   • 在「Cloud Build 設定檔位置」欄位中，在 / 後面輸入 cloudbuild.yaml。

4. 按一下「建立」即可儲存建構觸發條件。

   提示：如果您需要為多個專案建立自動建構觸發條件，可以使用 Build Triggers API。

5. 在 Cloud Shell 中，將應用程式程式碼推送到 Cloud Source Repositories，以在 Cloud Build 中觸發 CI 管道。

   cd ~/kubernetes-engine-samples/management/gitops-style-delivery/
   git push google master
   

6. 開啟 Cloud Build 主控台。

   前往 Cloud Build

   畫面上會顯示您最近執行及完成的建構作業。您可以點選建構作業，追蹤執行情況並查看記錄檔。

建立持續推送軟體更新管道

Cloud Build 也會用於持續推送軟體更新管道。每次將修訂版本推送到「hello-cloudbuild-env」存放區的「candidate」分支版本時，管道都會執行。管道會將新版本的資訊清單套用於 Kubernetes 叢集，如果套用成功，則會將資訊清單複製到「production」分支。此過程具有以下屬性：

• 「candidate」分支版本是部署作業的嘗試記錄。
• 「production」分支版本是成功部署的歷史記錄。
• 您可以查看 Cloud Build 中成功和失敗的部署。
• 您可以重新執行對應的 Cloud Build 建構作業，復原到任何之前的部署。復原作業還會更新「production」分支版本，以真實地反映部署的歷史記錄。

您將會修改持續整合管道以更新「hello-cloudbuild-env」存放區的「candidate」分支版本，從而觸發持續推送軟體更新管道。

將 GKE 存取權授予 Cloud Build

如要在 Kubernetes 叢集部署應用程式，Cloud Build 需要 Kubernetes Engine 開發人員 Identity and Access Management 角色。

PROJECT_NUMBER="$(gcloud projects describe ${PROJECT_ID} --format='get(projectNumber)')"
gcloud projects add-iam-policy-binding ${PROJECT_NUMBER} \
    --member=serviceAccount:${PROJECT_NUMBER}@cloudbuild.gserviceaccount.com \
    --role=roles/container.developer

初始化「hello-cloudbuild-env」存放區

您需要使用兩個分支版本 (「production」和「candidate」) 以及描述部署過程的 Cloud Build 設定檔來初始化「hello-cloudbuild-env」存放區。

1. 在 Cloud Shell 中，複製「hello-cloudbuild-env」存放區並建立「production」分支版本。

   cd ~
   gcloud source repos clone hello-cloudbuild-env
   cd ~/kubernetes-engine-samples/management/gitops-style-delivery/
   git checkout -b production
   

2. 複製「hello-cloudbuild-app」存放區中提供的 cloudbuild-delivery.yaml 檔案，並確認變更。

   cd ~/kubernetes-engine-samples/management/gitops-style-delivery/
   cp ~/hello-cloudbuild-app/cloudbuild-delivery.yaml ~/kubernetes-engine-samples/management/gitops-style-delivery/cloudbuild.yaml
   git add .
   git commit -m "Create cloudbuild.yaml for deployment"
   

   cloudbuild-delivery.yaml 檔案描述了要在 Cloud Build 中執行的部署過程。其中有兩個步驟：

   1. Cloud Build 在 GKE 叢集上套用資訊清單。

   2. 如果成功，Cloud Build 將在「production」分支版本上複製資訊清單。

   steps:
   # This step deploys the new version of our container image
   # in the hello-cloudbuild Kubernetes Engine cluster.
   - name: 'gcr.io/cloud-builders/kubectl'
     id: Deploy
     args:
     - 'apply'
     - '-f'
     - 'kubernetes.yaml'
     env:
     - 'CLOUDSDK_COMPUTE_REGION=us-central1'
     - 'CLOUDSDK_CONTAINER_CLUSTER=hello-cloudbuild'
   
   # This step copies the applied manifest to the production branch
   # The COMMIT_SHA variable is automatically
   # replaced by Cloud Build.
   - name: 'gcr.io/cloud-builders/git'
     id: Copy to production branch
     entrypoint: /bin/sh
     args:
     - '-c'
     - |
       set -x && \
       # Configure Git to create commits with Cloud Build's service account
       git config user.email $(gcloud auth list --filter=status:ACTIVE --format='value(account)') && \
       # Switch to the production branch and copy the kubernetes.yaml file from the candidate branch
       git fetch origin production && git checkout production && \
       git checkout $COMMIT_SHA kubernetes.yaml && \
       # Commit the kubernetes.yaml file with a descriptive commit message
       git commit -m "Manifest from commit $COMMIT_SHA
       $(git log --format=%B -n 1 $COMMIT_SHA)" && \
       # Push the changes back to Cloud Source Repository
       git push origin production

3. 建立一個「candidate」分支版本，並將兩個分支版本推送到 Cloud Source Repositories。

   git checkout -b candidate
   git push origin production
   git push origin candidate
   

4. 將原始碼存放區寫入者身分與存取權管理角色授予「hello-cloudbuild-env」存放區的 Cloud Build 服務帳戶。

   PROJECT_NUMBER="$(gcloud projects describe ${PROJECT_ID} \
       --format='get(projectNumber)')"
   cat >/tmp/hello-cloudbuild-env-policy.yaml <<EOF
   bindings:
   - members:
     - serviceAccount:${PROJECT_NUMBER}@cloudbuild.gserviceaccount.com
     role: roles/source.writer
   EOF
   gcloud source repos set-iam-policy \
       hello-cloudbuild-env /tmp/hello-cloudbuild-env-policy.yaml
   

為持續推送軟體更新管道建立觸發條件

在本節中，您會為 Cloud Build 設定觸發條件：只要對「hello-cloudbuild-env」存放區的「candidate」分支版本進行推送，即會觸發 Cloud Build。

1. 開啟 Cloud Build 的「Triggers」(觸發條件) 頁面。

   前往「Triggers」(觸發條件)

2. 按一下「建立觸發條件」。

3. 填寫下列選項：

   • 在「Name」(名稱) 欄位中輸入 hello-cloudbuild-deploy。
   • 在「事件」下方，選取「推送至分支版本」。
   • 在「來源」下方，將「存放區」設為 hello-cloudbuild-env，並將「分支版本」設為 ^candidate$。
   • 在「Configuration」(設定) 下方，選取「Cloud Build configuration file (yaml or json)」(Cloud Build 設定檔 (yaml 或 json))。
   • 在「Cloud Build 設定檔位置」欄位中，在 / 後面輸入 cloudbuild.yaml。

4. 點選「建立」。

修改持續整合管道，觸發持續推送軟體更新管道

在本節中，您將向持續整合管道新增一些步驟，以便產生新版本的 Kubernetes 資訊清單，並將其推送到「hello-cloudbuild-env」存放區，藉此觸發持續推送軟體更新管道。

1. 將 cloudbuild.yaml 檔案替換為 cloudbuild-trigger-cd.yaml 檔案中的擴充範例。

   cd ~/kubernetes-engine-samples/management/gitops-style-delivery/
   cp cloudbuild-trigger-cd.yaml cloudbuild.yaml
   

   cloudbuild-trigger-cd.yaml 是 cloudbuild.yaml 檔案的擴充版本。該版本新增的步驟如下：產生新的 Kubernetes 資訊清單，並觸發持續推送軟體更新管道。

   。
   # This step clones the hello-cloudbuild-env repository
   - name: 'gcr.io/cloud-builders/gcloud'
     id: Clone env repository
     entrypoint: /bin/sh
     args:
     - '-c'
     - |
       gcloud source repos clone hello-cloudbuild-env && \
       cd hello-cloudbuild-env && \
       git checkout candidate && \
       git config user.email $(gcloud auth list --filter=status:ACTIVE --format='value(account)')
   
   # This step generates the new manifest
   - name: 'gcr.io/cloud-builders/gcloud'
     id: Generate manifest
     entrypoint: /bin/sh
     args:
     - '-c'
     - |
        sed "s/GOOGLE_CLOUD_PROJECT/${PROJECT_ID}/g" kubernetes.yaml.tpl | \
        sed "s/COMMIT_SHA/${SHORT_SHA}/g" > hello-cloudbuild-env/kubernetes.yaml
   
   # This step pushes the manifest back to hello-cloudbuild-env
   - name: 'gcr.io/cloud-builders/gcloud'
     id: Push manifest
     entrypoint: /bin/sh
     args:
     - '-c'
     - |
       set -x && \
       cd hello-cloudbuild-env && \
       git add kubernetes.yaml && \
       git commit -m "Deploying image us-central1-docker.pkg.dev/$PROJECT_ID/my-repository/hello-cloudbuild:${SHORT_SHA}
       Built from commit ${COMMIT_SHA} of repository hello-cloudbuild-app
       Author: $(git log --format='%an <%ae>' -n 1 HEAD)" && \
       git push origin candidate
   

2. 確認修改並將其推送到 Cloud Source Repositories。

   cd ~/kubernetes-engine-samples/management/gitops-style-delivery/
   git add cloudbuild.yaml
   git commit -m "Trigger CD pipeline"
   git push google master
   

   這會觸發 Cloud Build 中的持續整合管道。

3. 檢查持續整合建構作業。

   前往 Cloud Build

   您最近為「hello-cloudbuild-app」存放區執行及完成的建構作業會顯示在畫面上。您可以按一下建構作業，追蹤執行情況並檢查記錄。此管道的最後一個步驟會將新的資訊清單推送到「hello-cloudbuild-env」存放區，並觸發持續推送軟體更新管道。

4. 檢查持續推送軟體更新建構作業。

   前往 Cloud Build

   您最近為 hello-cloudbuild-env 存放區執行及完成的建構作業會顯示在畫面上。您可以點選該建構作業，追蹤執行情況並查看記錄檔。

測試完整管道

完整的 CI/CD 管道現已設定完畢，在本節中，您將進行端到端的測試。

1. 前往「GKE Services」(GKE 服務) 頁面。

   前往 Google Kubernetes Engine 服務

   清單中應該有一個名為 hello-cloudbuild 的服務，這是由最近完成的持續推送軟體更新建構作業所建立。

2. 按一下「hello-cloudbuild」服務的端點。 畫面上會顯示「Hello World!」。如果沒有端點，或者若您看到負載平衡器錯誤，則可能需要等待幾分鐘才能完全初始化負載平衡器。 視需要點選「重新整理」來更新頁面。

3. 在 Cloud Shell 中，在應用程式和單元測試中將「Hello World」替換為「Hello Cloud Build」。

   cd ~/kubernetes-engine-samples/management/gitops-style-delivery/
   sed -i 's/Hello World/Hello Cloud Build/g' app.py
   sed -i 's/Hello World/Hello Cloud Build/g' test_app.py
   

4. 確認並將變更推送到 Cloud Source Repositories。

   git add app.py test_app.py
   git commit -m "Hello Cloud Build"
   git push google master
   

   這會觸發完整的 CI/CD 管道。

5. 幾分鐘後，在瀏覽器中重新載入應用程式。 畫面會顯示「Hello Cloud Build!」。

測試復原作業

在本節中，您將復原到顯示「Hello World!」的應用程式版本。

1. 開啟 Cloud Build 主控台以存取「hello-cloudbuild-env」存放區。

   前往 Cloud Build

2. 點選第二新的可用版本。

3. 按一下 [Rebuild] (重新建構)。

4. 建構完成後，在瀏覽器中重新載入應用程式。 「Hello World!」會再次顯示。