本頁面由 Cloud Translation API 翻譯而成。

在部署前後執行掛鉤

本快速入門說明如何執行部署掛鉤，也就是在使用 Cloud Deploy 部署前或部署後執行的任意程式。

在本快速入門導覽課程中，您將執行以下操作：

建立一個 GKE 叢集或一個 Cloud Run 服務。

您也可以使用 GKE Enterprise 叢集，但本快速入門課程只使用 GKE 和 Cloud Run。
建立 Skaffold 設定，以及 Kubernetes 資訊清單或 Cloud Run 服務定義。

您可以在 Skaffold 設定檔中設定要執行的部署鉤子。您可以指定要執行的部署前容器，以及要執行的部署後容器。
定義 Cloud Deploy 推送管道和部署目標。

在提交管道設定中，您會參照 skaffold.yaml 中定義的部署掛鉤，以便執行這些掛鉤。

這個管道只包含一個階段，且只使用一個目標。
建立會自動部署至目標的版本。

其中一個鉤子會在應用程式部署前執行，另一個則會在應用程式部署後執行。
使用Google Cloud 控制台的 Cloud Deploy「Rollout details」頁面，查看 Cloud Build 記錄中部署前後掛鉤的結果。

事前準備

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.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

如果您已安裝 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"

為特定執行階段新增開發人員角色。

針對 GKE：

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/container.developer"

針對 Cloud Run：

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/run.developer"

新增 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

建立執行階段環境

如果您要部署至 Cloud Run，可以略過這項指令。

針對 GKE，請建立一個叢集：deploy-hooks-cluster，並使用預設設定。叢集的 Kubernetes API 端點必須能夠透過網際網路存取。根據預設，外部可以存取 GKE 叢集。

gcloud container clusters create-auto deploy-hooks-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

準備 Skaffold 設定和應用程式資訊清單

Cloud Deploy 會使用 Skaffold 提供詳細資訊，說明要部署哪些內容，以及如何將這些內容部署至目標。

在本快速入門課程中，您會建立 skaffold.yaml 檔案，用於識別用於部署範例應用程式的資訊清單，以及在部署前後執行的容器 (部署掛鉤)。

開啟終端機視窗。

GKE

mkdir deploy-hooks-gke-quickstart
cd deploy-hooks-gke-quickstart

Cloud Run

mkdir deploy-hooks-run-quickstart
cd deploy-hooks-run-quickstart

建立名為 skaffold.yaml 的檔案，並在當中加入下列內容：

GKE

apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - k8s-pod.yaml
deploy:
  kubectl: {}
customActions:
- name: predeploy-action
  containers:
  - name: predeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a predeploy action"' ]
- name: postdeploy-action
  containers:
  - name: postdeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a postdeploy action"' ]

Cloud Run

apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}
customActions:
- name: predeploy-action
  containers:
  - name: predeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a predeploy action"' ]
- name: postdeploy-action
  containers:
  - name: postdeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a postdeploy action"' ]

這個檔案包含 customActions: 節。這會定義在部署前後執行的容器，也就是掛鉤。

如要進一步瞭解這個設定檔，請參閱 skaffold.yaml 參考資料。

建立應用程式定義，也就是 Cloud Run 的服務定義或 GKE 的 Kubernetes 資訊清單。
GKE
建立名為 k8s-pod.yaml 的檔案，並在其中加入下列內容：
```
apiVersion: v1
kind: Pod
metadata:
  name: my-hooks-pod
spec:
  containers:
  - name: nginx
    image: my-app-image
```
這個檔案是基本 Kubernetes 資訊清單，會套用至叢集以部署應用程式。要部署的容器映像檔會在此處設為預留位置 my-app-image，並在您建立版本時替換為特定映像檔。
Cloud Run
建立名為 service.yaml 的檔案，並在其中加入下列內容：
```
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: my-hooks-run-service
spec:
  template:
    spec:
      containers:
      - image: my-app-image
```
這個檔案是簡易的 Cloud Run 服務定義，用於部署應用程式。要部署的容器映像檔會在此處設為預留位置 my-app-image，並在建立版本時，以特定映像檔取代。

建立推送管道和目標

您可以在單一檔案或個別檔案中定義管道和目標。在本快速入門導覽課程中，您將建立單一檔案。

建立推送管道和目標定義：

GKE

在 deploy-hooks-gke-quickstart 目錄中建立新檔案 clouddeploy.yaml，並加入下列內容：

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-hooks-demo-app-gke-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: hooks-staging
    profiles: []
    strategy:
      standard:
        predeploy:
          actions: ["predeploy-action"]
        postdeploy:
          actions: ["postdeploy-action"]
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: hooks-staging
description: hooks staging cluster
gke:
  cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-hooks-cluster

Cloud Run

在 deploy-hooks-run-quickstart 目錄中建立新檔案 clouddeploy.yaml，並加入下列內容：

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-hooks-demo-app-run-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: hooks-staging
    profiles: []
    strategy:
      standard:
        predeploy:
          actions: ["predeploy-action"]
        postdeploy:
          actions: ["postdeploy-action"]
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: hooks-staging
description: staging Run service
run:
  location: projects/PROJECT_ID/locations/us-central1

使用 Cloud Deploy 服務註冊管道和目標：
```
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
```
您現在擁有一個含有一個目標的發布管道，可用於部署應用程式，並執行預先部署和後期部署工作。
確認管道和目標：

在 Google Cloud 控制台中，前往 Cloud Deploy 的「Delivery pipelines」(推送管道) 頁面，查看可用的推送管道清單。

開啟「Delivery pipelines」頁面

系統會顯示您剛建立的推送管道，並在「目標」欄中列出一個目標。

建立版本

版本是代表待部署變更的集中式 Cloud Deploy 資源。發布管道會定義該版本的生命週期。如要進一步瞭解這個生命週期，請參閱 Cloud Deploy 服務架構。

GKE

從 deploy-hooks-gke-quickstart 目錄執行下列指令，建立代表要部署的容器映像檔的 release 資源：

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-hooks-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

請注意 --images= 旗標，您可以使用該旗標將資訊清單中的預留位置 (my-app-image) 替換為特定 SHA 合格圖片。Google 建議您以這種方式建立資訊清單範本，並在建立版本時使用 SHA 合格的映像檔名稱。

Cloud Run

從 deploy-hooks-run-quickstart 目錄執行下列指令，建立代表要部署的容器映像檔的 release 資源：

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-hooks-demo-app-run-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

請注意 --images= 標記，您可以使用該標記將服務定義中的預留位置 (my-app-image) 替換為特定 SHA 合格映像檔。Google 建議您以這種方式建立服務和工作定義範本，並在建立版本時使用 SHA 合格映像檔名稱。

如同所有版本 (除非包含 --disable-initial-rollout)，Cloud Deploy 也會自動建立rollout 資源。應用程式會自動部署至為此提交管道設定的單一目標。

此外，部署前工作會在應用程式部署前執行，而部署後工作會在應用程式部署後執行。

在 Google Cloud 控制台中查看結果

幾分鐘後，系統就會將版本部署至目標執行階段。

我們設定的部署前後掛鉤 (僅供示範) 會將字串印到 Cloud Build 記錄中。我們可以查看這些記錄，確認鉤子是否正常運作。

在 Google Cloud 控制台中，前往 Cloud Deploy 的「Delivery pipelines」(推送管道) 頁面，查看推送管道 (「deploy-hooks-demo-app-gke-1」或「deploy-hooks-demo-app-run-1」)。

開啟「Delivery pipelines」頁面
按一下推送管道名稱 (「deploy-hooks-demo-app-gke-1」或「deploy-hooks-demo-app-run-1」)。

管道示意圖會顯示應用程式的部署狀態。由於管道中只有一個階段，因此視覺化資訊只會顯示一個節點。

你的版本會列在「發布管道詳細資料」下方的「版本」分頁中。
按一下「發布」分頁標籤下方的「發布管道詳細資料」。
按一下推行名稱，即可查看推行詳細資料。

「Predeploy」和「Postdeploy」會列為工作。
按一下「預先部署」

系統會顯示工作執行記錄。
向下捲動記錄項目清單，找出 predeploy-echo，然後按一下該項目。

請注意 textPayload。該字串是 Skaffold 設定中 predeploy-action 的設定內容。
按一下「Postdeploy」工作，然後找出 postdeploy-echo 記錄項目。

清除所用資源

如要避免系統向您的 Google Cloud 帳戶收取您在本頁所用資源的費用，請按照下列步驟操作。

刪除 GKE 叢集或 Cloud Run 服務：

GKE

gcloud container clusters delete deploy-hooks-cluster --region=us-central1 --project=PROJECT_ID

Cloud Run

gcloud run services delete my-hooks-run-service --region=us-central1 --project=PROJECT_ID

刪除推送管道、目標、版本和推出項目：

gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID

刪除 Cloud Deploy 建立的 Cloud Storage 值區。

一個結尾是 _clouddeploy，另一個是 [region].deploy-artifacts.[project].appspot.com。

開啟 Cloud Storage 瀏覽器頁面

大功告成，您已經完成本快速入門導覽課程！

在部署前後執行掛鉤

事前準備

建立執行階段環境

準備 Skaffold 設定和應用程式資訊清單

GKE

Cloud Run

GKE

Cloud Run

GKE

Cloud Run

建立推送管道和目標

GKE

Cloud Run

建立版本

GKE

Cloud Run

在 Google Cloud 控制台中查看結果

清除所用資源

GKE

Cloud Run

後續步驟