在部署前后运行钩子

准备 Skaffold 配置和应用清单

Cloud Deploy 使用 Skaffold 提供要部署的内容的详细信息，以及如何将这些内容部署到您的目标。

在本快速入门中，您将创建一个 skaffold.yaml 文件，以标识要用于部署示例应用的清单，并标识要在部署之前和之后运行的容器（部署钩子）。

1. 打开一个终端窗口。

2. 创建一个新目录，并导航至该目录。

   GKE

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

   Cloud Run

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

3. 创建名为 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: stanza。这会定义在部署之前和之后运行的容器（即钩子）。

   如需详细了解此配置文件，请参阅 skaffold.yaml 参考文档。

4. 为您的应用创建定义 - 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，当您创建发布版本时，该占位符会被替换为具体映像。

创建交付流水线和目标

您可以在一个文件中或在单独的文件中定义流水线和目标。在本快速入门中，您将创建一个文件。

1. 创建交付流水线和目标定义：

   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
   

2. 在 Cloud Deploy 服务中注册流水线和目标：

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

   现在，您已经有了包含一个目标的交付流水线，可以部署应用并运行部署前和部署后作业了。

3. 确认您的流水线和目标：

   在 Google Cloud 控制台中，导航到 Cloud Deploy 交付流水线页面，以查看可用交付流水线的列表。

   打开“交付流水线”页面

   此时将显示您刚刚创建的交付流水线，并且目标列会列出了一个目标。

   

创建版本

版本是表示要部署的更改的中央 Cloud Deploy 资源。交付流水线定义该版本的生命周期。请参阅 Cloud Deploy 服务架构，详细了解该生命周期。

 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

 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

与所有版本一样（除非它们包含 --disable-initial-rollout），Cloud Deploy 还会自动创建部署资源。应用会自动部署到为此交付流水线配置的目标中。

此外，预部署作业在应用部署之前运行，部署后作业在应用部署之后运行。

在 Google Cloud 控制台中查看结果

几分钟后，您的发布版本就会部署到目标运行时。

我们配置的部署前钩子和部署后钩子（仅用于演示）会将字符串输出到 Cloud Build 日志。我们可以查看这些日志，以确认钩子是否按预期工作。

1. 在 Google Cloud 控制台中，导航到 Cloud Deploy 交付流水线页面，以查看您的交付流水线（“deploy-hooks-demo-app-gke-1”或“deploy-hooks-demo-app-run-1”）。

   打开“交付流水线”页面

2. 点击交付流水线的名称（“deploy-hooks-demo-app-gke-1”或“deploy-hooks-demo-app-run-1”）。

   流水线直观显示将显示应用的部署状态。由于流水线中只有一个阶段，因此可视化图表仅显示一个节点。

   

   您的版本列在版本标签页中交付流水线详细信息下。

3. 在交付流水线详情下，点击发布标签页。

4. 点击发布名称即可查看发布详情。

   

   部署前和部署后列为作业。

5. 点击部署前

   系统会显示作业运行日志。

6. 在日志条目列表中向下滚动，找到 predeploy-echo，然后点击它。

   

   请注意 textPayload。该字符串是在 Skaffold 配置的 predeploy-action 中配置的。

7. 点击 Postdeploy 作业，然后找到 postdeploy-echo 日志条目。