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.

   Sie können auch einen GKE Enterprise-Cluster dafür verwenden, in diesem Schnellstart werden jedoch 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 legen Sie fest, welche Deployment-Hooks ausgeführt werden sollen. Sie geben einen Container an, der vor der Bereitstellung und einen Container an, der nach der Bereitstellung ausgeführt werden soll.

3. Definieren Sie Ihre Cloud Deploy-Bereitstellungspipeline und das Bereitstellungsziel.

   In der Bereitstellungspipeline-Konfiguration verweisen Sie auf 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 für das Ziel bereitgestellt wird.

   Einer der Hooks wird vor der Bereitstellung der Anwendung und der andere danach ausgeführt.

5. Die Ergebnisse der Pre- und Post-Bereitstellungs-Hooks finden Sie in den Cloud Build-Logs auf der Seite Roll-out-Details von Cloud Deploy in der 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, prüfen Sie, ob Sie die neueste Version verwenden:

gcloud components update

12. Achten Sie darauf, dass das Compute Engine-Standarddienstkonto ausreichend Berechtigungen hat.

    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 Ihre 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 die Bereitstellung in Cloud Run ausführen, können Sie diesen Befehl überspringen.

Erstellen Sie für GKE einen Cluster: deploy-hooks-cluster mit den Standardeinstellungen. Der Kubernetes API-Endpunkt des Clusters muss über das öffentliche Internet erreichbar sein. Auf GKE-Cluster kann standardmäßig extern zugegriffen werden.

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

Skaffold-Konfiguration und Anwendungsmanifest vorbereiten

Cloud Deploy verwendet Skaffold, um Details zu den bereitzustellenden Elementen und deren korrekte Bereitstellung für das Ziel anzugeben.

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 rufen Sie es auf.

   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 den customActions:-Satz. Hier werden die Container definiert, 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. Das bereitzustellende Container-Image wird hier als Platzhalter my-app-image festgelegt, der beim Erstellen der Version durch das entsprechende Image ersetzt wird.

   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, die zum Bereitstellen der Anwendung verwendet wird. Das zu implementierende Container-Image wird hier als Platzhalter (my-app-image) festgelegt. Es wird durch das spezifische Image ersetzt, wenn Sie die Version erstellen.

Hinweis: Wenn Sie pro Ziel verschiedene Manifeste verwenden möchten, lesen Sie diesen Artikel zum Verwalten von Manifesten, um mehr über die Verwendung von Skaffold-Profilen zu erfahren.

Lieferpipeline und Ziel erstellen

Sie können Pipeline und 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 die 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 die 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 Lieferpipeline enthalten. Sie können Ziele auch in einer separaten Datei oder 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, mit der Sie Ihre Anwendung bereitstellen und Ihre Jobs vor und nach der Bereitstellung ausführen können.

3. Bestätigen Sie Pipeline und Ziele:

   Rufen Sie in der Google Cloud Console die Seite Lieferpipelines von Cloud Deploy auf, um eine Liste der verfügbaren Lieferpipelines aufzurufen.

   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 die bereitgestellten Änderungen darstellt. Die Bereitstellungspipeline definiert den Lebenszyklus dieser Version. Weitere Informationen zu diesem Lebenszyklus finden Sie unter Cloud Deploy-Dienstarchitektur.

GKE

Führen Sie folgenden Befehl im Verzeichnis deploy-hooks-gke-quickstart aus, um eine release-Ressource zu erstellen, die das bereitzustellende Container-Image darstellt:

 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

Beachten Sie das --images=-Flag, mit dem Sie den Platzhalter (my-app-image) im Manifest durch das spezifische, SHA-qualifizierte Image ersetzen. Google empfiehlt, Ihre Manifeste auf diese Weise zu modellieren und beim Erstellen von Releases SHA-qualifizierte Image-Namen zu verwenden.

Cloud Run

Führen Sie folgenden Befehl im Verzeichnis deploy-hooks-run-quickstart aus, um eine release-Ressource zu erstellen, die das bereitzustellende Container-Image darstellt:

 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

Beachten Sie das --images=-Flag, mit dem Sie den Platzhalter (my-app-image) in der Dienstdefinition durch das spezifische, SHA-qualifizierte Image ersetzen. Google empfiehlt, Ihre Dienst- und Jobdefinitionen auf diese Weise zu modellieren und beim Erstellen von Releases SHA-qualifizierte Image-Namen zu verwenden.

Wie bei allen Releases (außer bei Releases mit --disable-initial-rollout) erstellt Cloud Deploy automatisch auch eine Bereitstellungsressource. Die Anwendung wird automatisch für das für diese Bereitstellungspipeline konfigurierte Ziel bereitgestellt.

Außerdem wird der Job vor der Bereitstellung vor der Bereitstellung der Anwendung und der Job nach der Bereitstellung nach der Bereitstellung ausgeführt.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten wird der Release in der Ziellaufzeit bereitgestellt.

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

1. Rufen Sie in der Google Cloud Console die Seite Lieferpipelines von Cloud Deploy auf, um Ihre Bereitstellungspipeline („deploy-hooks-demo-app-gke-1“ oder „deploy-hooks-demo-app-run-1“) aufzurufen.

   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 Pipelinevisualisierung zeigt den Bereitstellungsstatus der App. 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 Lieferpipeline auf den Tab Roll-outs.

4. Klicken Sie auf den Namen der Einführung, um die Details aufzurufen.

   

   Predeploy und Postdeploy sind als Jobs aufgeführt.

5. Klicken Sie auf Vorab bereitstellen.

   Das Protokoll der Jobausführung 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 in der Skaffold-Konfiguration unter predeploy-action konfiguriert.

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. Löschen Sie den GKE-Cluster oder Cloud Run-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. So 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 zum Bereitstellen von Anwendungen

• Probieren Sie die Schritt-für-Schritt-Anleitung für Cloud Deploy aus.

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