Hooks vor und nach der Bereitstellung ausführen

Hooks vor und nach der Bereitstellung ausführen

In dieser Kurzanleitung erfahren Sie, wie Sie einen Bereitstellungs-Hook ausführen, also ein beliebiges Programm, das vor oder nach der Bereitstellung mit Cloud Deploy ausgeführt wird.

Dieser Schnellstart erläutert folgende Schritte:

1. Erstellen Sie einen GKE-Cluster oder einen Cloud Run-Dienst.

   Auch hierfür können Sie einen GKE Enterprise-Cluster verwenden, In der Kurzanleitung werden nur GKE und Cloud Run verwendet.

2. Erstellen Sie eine Skaffold-Konfiguration und entweder ein Kubernetes- Manifest oder eine Cloud Run-Dienstdefinition.

   In der Skaffold-Konfigurationsdatei konfigurieren Sie die auszuführenden Deployment-Hooks. Sie geben einen Container an, der vor der Bereitstellung ausgeführt werden soll, und einen Container die nach der Bereitstellung ausgeführt werden sollen.

3. Cloud Deploy-Bereitstellungspipeline und -Deployment definieren Ziel.

   In der Konfiguration der Bereitstellungspipeline referenzieren Sie die Bereitstellungs-Hooks die in skaffold.yaml definiert wurden, um diese Hooks auszuführen.

   Diese Pipeline umfasst nur eine Phase und verwendet nur ein Ziel.

4. Erstellen Sie einen Release, der automatisch im Ziel bereitgestellt wird.

   Einer der Hooks wird ausgeführt, bevor die Anwendung bereitgestellt wird, und der andere ist ausgeführt werden soll.

5. Ergebnisse der Hooks vor und nach der Bereitstellung in Cloud Build ansehen Logs mithilfe der Cloud Deploy-Seite Roll-out-Details in Google Cloud Console

Hinweise

1. 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.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

Wenn Sie die Befehlszeile bereits installiert haben, achten Sie darauf, dass Sie die neueste Version:

gcloud components update

12. Stellen Sie sicher, dass die Standardeinstellungen Das Compute Engine-Dienstkonto verfügt über ausreichende Berechtigungen.

    Das Dienstkonto hat möglicherweise bereits die erforderlichen Berechtigungen. Diese Schritte gelten für Projekte, die automatische Rollenzuweisungen für Standarddienstkonten deaktivieren.

1. Fügen Sie zuerst die Rolle clouddeploy.jobRunner hinzu:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/clouddeploy.jobRunner"
   

2. Fügen Sie die Entwicklerrolle für die jeweilige Laufzeit hinzu.
• Für GKE:

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
      --format="value(projectNumber)")[e-mail] \
      --role="roles/container.developer"
  

• Für Cloud Run:

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
      --format="value(projectNumber)")[e-mail] \
      --role="roles/run.developer"
  

3. Fügen Sie die Rolle iam.serviceAccountUser hinzu, die die Berechtigung actAs zum Bereitstellen in der Laufzeit enthält:

   gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/iam.serviceAccountUser" \
       --project=PROJECT_ID
   

Laufzeitumgebung erstellen

Wenn Sie eine Bereitstellung in Cloud Run vornehmen, können Sie diesen Befehl überspringen.

Erstellen Sie für GKE einen Cluster: deploy-hooks-cluster, mit Standardeinstellungen. Der Kubernetes API-Endpunkt des Clusters muss die über das öffentliche Internet erreichbar sind. GKE-Cluster sind standardmäßig extern zugänglich.

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

Skaffold-Konfiguration und Anwendungsmanifest vorbereiten

Cloud Deploy nutzt Skaffold, um was Sie bereitstellen und wie Sie diese auf Ihrem target angeben.

In dieser Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, in der das Manifest für die Bereitstellung der Beispielanwendung und die Container, die vor und nach der Bereitstellung ausgeführt werden sollen (die Bereitstellungs-Hooks), angegeben werden.

1. Öffnen Sie ein Terminalfenster.

2. Erstellen Sie ein neues Verzeichnis und wechseln Sie zu diesem Verzeichnis.

   GKE

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

   Cloud Run

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

3. Erstellen Sie eine Datei mit dem Namen skaffold.yaml und mit folgendem Inhalt:

   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"' ]
   

   Diese Datei enthält die customActions:-Stanza. Definiert die Container die vor und nach der Bereitstellung ausgeführt werden sollen: die Hooks.

   Weitere Informationen zu dieser Konfigurationsdatei finden Sie in der skaffold.yaml-Referenz.

4. Erstellen Sie die Definition für Ihre Anwendung – eine Dienstdefinition für Cloud Run oder ein Kubernetes-Manifest für GKE.

   GKE

   Erstellen Sie eine Datei mit dem Namen k8s-pod.yaml und folgendem Inhalt:

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-hooks-pod
   spec:
     containers:
     - name: nginx
       image: my-app-image
   

   Diese Datei ist ein einfaches Kubernetes Manifest das auf den Cluster angewendet wird, um die Anwendung bereitzustellen.

   Cloud Run

   Erstellen Sie eine Datei mit dem Namen service.yaml und folgendem Inhalt:

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: my-hooks-run-service
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   Diese Datei ist eine einfache Cloud Run-Dienstdefinition, der bei der Bereitstellung zum Erstellen von Cloud Run verwendet wird Service.

Hinweis: Wenn Sie für jedes Ziel unterschiedliche Manifeste verwenden möchten, lesen Sie diesen Artikel. zur Verwaltung von Manifesten, Weitere Informationen zur Verwendung von Skaffold-Profilen.

Bereitstellungspipeline und Ziel erstellen

Sie können Ihre Pipeline und das Ziel in einer Datei oder in separaten Dateien definieren. In dieser Kurzanleitung erstellen Sie nur eine Datei.

1. Erstellen Sie die Bereitstellungspipeline und die Zieldefinition:

   GKE

   Erstellen Sie im Verzeichnis deploy-hooks-gke-quickstart eine neue Datei: clouddeploy.yaml mit folgendem Inhalt:

   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

   Erstellen Sie im Verzeichnis deploy-hooks-run-quickstart eine neue Datei: clouddeploy.yaml mit folgendem Inhalt:

   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
   

   Hinweis: In dieser Datei ist das Ziel in der Bereitstellungspipeline enthalten, aber Sie können Ziele in einer separaten Datei oder in mehreren separaten Dateien definieren.

2. Registrieren Sie Ihre Pipeline und Ziele beim Cloud Deploy-Dienst:

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

   Sie haben jetzt eine Bereitstellungspipeline mit einem Ziel, und die Jobs vor und nach der Bereitstellung ausführen.

3. Bestätigen Sie Pipeline und Ziele:

   Rufen Sie in der Google Cloud Console Cloud Deploy auf. Seite Bereitstellungspipelines zur Liste der verfügbaren Bereitstellungspipelines Pipelines.

   Zur Seite der Lieferpipelines

   Die soeben erstellte Bereitstellungspipeline wird angezeigt. In der Spalte Ziele ist ein Ziel aufgeführt.

   

Release erstellen

Ein Release ist die zentrale Cloud Deploy-Ressource, die den Änderungen bereitgestellt werden. Die Bereitstellungspipeline definiert den Lebenszyklus Veröffentlichung. Weitere Informationen zu diesem Lebenszyklus finden Sie unter Cloud Deploy-Dienstarchitektur.

GKE

Führen Sie den folgenden Befehl über die deploy-hooks-gke-quickstart aus. Verzeichnis zum Erstellen einer release-Ressource, die den Container darstellt bereitzustellendes Image:

 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

Cloud Run

Führen Sie den folgenden Befehl über die deploy-hooks-run-quickstart aus. Verzeichnis zum Erstellen einer release-Ressource, die den Container darstellt bereitzustellendes Image:

 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:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

Wie bei allen Releases (außer sie enthalten --disable-initial-rollout): Cloud Deploy erstellt automatisch eine rollout-Ressource hinzu. Die Anwendung wird automatisch für das für diese Bereitstellungspipeline konfigurierte Ziel bereitgestellt.

Außerdem wird der Job vor der Bereitstellung ausgeführt, bevor die Anwendung bereitgestellt wird. die nach der Bereitstellung ausgeführt werden.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten ist der Release in Ihrer Ziellaufzeit bereitgestellt.

Die von uns konfigurierten Pre- und Post-Deploy-Hooks drucken Strings in die Cloud Build-Protokolle. Wir können diese Protokolle aufrufen, um zu bestätigen, funktionierten die Hooks wie erwartet.

1. Rufen Sie in der Google Cloud Console Cloud Deploy auf. Seite Bereitstellungspipelines zur Anzeige der Bereitstellungspipeline („deploy-hooks-demo-app-gke-1“ oder „deploy-hooks-demo-app-run-1“).

   Zur Seite der Lieferpipelines

2. Klicken Sie auf den Namen Ihrer Bereitstellungspipeline („deploy-hooks-demo-app-gke-1“ oder "deploy-hooks-demo-app-run-1").

   Die Pipeline-Visualisierung zeigt den Bereitstellungsstatus der Anwendung. Da es nur eine Phase in der Pipeline gibt, wird in der Visualisierung nur ein Knoten angezeigt.

   

   Ihre Version wird auf dem Tab Releases unter Details zur Lieferpipeline aufgeführt.

3. Klicken Sie unter Details zur Bereitstellungspipeline auf den Tab Einführungen.

4. Klicken Sie auf den Roll-out-Namen, um die Roll-out-Details aufzurufen.

   

   Predeploy und Postdeploy werden als Jobs aufgelistet.

5. Klicken Sie auf Vorab bereitstellen.

   Das Jobausführungslog wird angezeigt.

6. Scrollen Sie in der Liste der Logeinträge nach unten zu predeploy-echo und klicken Sie darauf.

   

   Beachten Sie das textPayload. Dieser String wurde im predeploy-action in deinem Skaffold-Konfiguration.

7. Klicken Sie auf den Job Postdeploy und suchen Sie den postdeploy-echo-Logeintrag.

   

Bereinigen

Mit den folgenden Schritten vermeiden Sie, dass Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen in Rechnung gestellt werden:

1. GKE-Cluster oder Cloud Run löschen Dienst:

   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
   

2. Löschen Sie die Bereitstellungspipeline, das Ziel, den Release und das Roll-out:

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

3. Löschen Sie die von Cloud Deploy erstellten Cloud Storage-Buckets.

   Eine endet mit _clouddeploy und die andere mit [region].deploy-artifacts.[project].appspot.com.

   Die Cloud Storage-Browserseite öffnen

Das war alles. Sie haben diesen Schnellstart abgeschlossen!

Nächste Schritte

• Weitere Informationen zu Cloud Deploy

• Grundlagen der Bereitstellung von Anwendungen kennenlernen

• Schritt-für-Schritt-Anleitung zu Cloud Deploy ausprobieren

• Informationen zum Kombinieren von Google Cloud-CI/CD-Tools, um Software effektiv für GKE zu entwickeln und bereitzustellen