Hooks vor und nach der Bereitstellung ausführen

Hooks vor und nach der Bereitstellung ausführen

In dieser Kurzanleitung erfahren Sie, wie Sie einen Bereitstellungshook ausführen. Das ist 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 dafür auch angehängte GKE-Cluster verwenden. In dieser Kurzanleitung werden jedoch nur GKE und Cloud Run verwendet.

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

   Die Konfiguration der Bereitstellungspipeline enthält die Definitionen der Bereitstellungshooks als tasks.

   Diese Pipeline enthält nur eine Phase und verwendet nur ein Ziel.

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

   In der Skaffold-Konfigurationsdatei geben Sie die Manifeste an, die Sie mit Cloud Deploy bereitstellen möchten.

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. Rufen Sie die Ergebnisse der Hooks vor und nach der Bereitstellung in den Cloud Build Logs auf. Verwenden Sie dazu in der Google Cloud Console die Cloud Deploy-Seite Rollout-Details.

Hinweis

Melden Sie sich in Ihrem Google Cloud Konto an. Wenn Sie noch kein Konto bei Google Cloudhaben, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis zu sehen und zu bewerten. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
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
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
Enable the APIs
Installieren Sie die Google Cloud CLI.
Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.
Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:
gcloud init
Hinweis: Sie können die gcloud CLI in der Google Cloud Console ausführen, ohne die Google Cloud CLI zu installieren. Wenn Sie die gcloud CLI in der Google Cloud Console ausführen möchten, verwenden Sie Cloud Shell.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

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

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Installieren Sie die Google Cloud CLI.

Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

Hinweis: Sie können die gcloud CLI in der Google Cloud Console ausführen, ohne die Google Cloud CLI zu installieren. Wenn Sie die gcloud CLI in der Google Cloud Console ausführen möchten, verwenden Sie Cloud Shell.

Wenn Sie die CLI bereits installiert haben, prüfen Sie, ob Sie die neueste Version verwenden:

gcloud components update

1. Prüfen Sie, ob das Standard Compute Engine-Dienstkonto die erforderlichen 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 spezifische 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 in Cloud Run bereitstellen, 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 über das öffentliche Internet erreichbar sein. GKE-Cluster sind standardmäßig extern zugänglich.

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

Bereitstellungspipeline 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. Öffnen Sie ein Terminalfenster.

2. Erstellen Sie ein neues Verzeichnis und wechseln Sie in dieses 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 die Definition für die Bereitstellungspipeline und das Ziel:

   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:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a predeploy action"' ]
           postdeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a 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:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a predeploy action"' ]
           postdeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a 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 Bereitstellungs-Pipeline enthalten. Sie können Ziele auch in einer separaten Datei oder mehreren separaten Dateien definieren.

4. 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 können Ihre Anwendung bereitstellen und Ihre Jobs vor und nach der Bereitstellung ausführen.

5. Bestätigen Sie Pipeline und Ziele:

   Rufen Sie in der Google Cloud Console die Cloud Deploy Bereitstellungspipelines-Seite auf, um eine Liste der verfügbaren Bereitstellung spipelines aufzurufen.

   Zur Seite der Lieferpipelines

   Die soeben erstellte Bereitstellungspipeline wird angezeigt und ein Ziel wird in der Spalte Ziele aufgeführt.

   

Skaffold-Konfigurationsdatei und Anwendungsmanifest erstellen

Cloud Deploy verwendet Skaffold, um die Manifeste zu identifizieren, die zum Bereitstellen der Beispiel-App für Ihr Ziel verwendet werden.

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

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - k8s-pod.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   

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

2. 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 ein Platzhalter, my-app-image, festgelegt, der beim Erstellen des Release durch das spezifische Image ersetzt wird, wenn Sie das Release erstellen.

   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 bereitzustellende Container-Image wird hier als Platzhalter my-app-imagefestgelegt, der beim Erstellen des Release durch das spezifische Image ersetzt wird.

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.

Release erstellen

Ein Release ist die zentrale Cloud Deploy-Ressource, die die bereitzustellenden Änderungen darstellt. Die Bereitstellungspipeline definiert den Lebenszyklus dieses Release. Weitere Informationen zu diesem Lebenszyklus finden Sie unter Cloud Deploy-Dienstarchitektur.

GKE

Führen Sie den folgenden Befehl im deploy-hooks-gke-quickstart Verzeichnis aus, um eine release Ressource zu erstellen, die das 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 templatieren und bei der Releaseerstellung SHA-qualifizierte Imagenamen zu verwenden.

Cloud Run

Führen Sie den folgenden Befehl im deploy-hooks-run-quickstart Verzeichnis aus, um eine release Ressource zu erstellen, die das 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:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

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 templatieren und bei der Releaseerstellung SHA-qualifizierte Imagenamen zu verwenden.

Wie bei allen Releases (sofern sie nicht --disable-initial-rollout enthalten), erstellt Cloud Deploy automatisch auch eine Rollout-Ressource. Die Anwendung wird automatisch für das eine Ziel bereitgestellt, das für diese Bereitstellungspipeline konfiguriert wurde.

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

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten wird Ihr Release in Ihrer Ziellaufzeit bereitgestellt.

Die von uns konfigurierten Hooks vor und nach der Bereitstellung geben (zu Testzwecken) Strings in die Cloud Build-Logs aus. Wir können diese Logs ansehen, um zu prüfen, ob die Hooks wie erwartet funktionieren.

1. Rufen Sie in der Google Cloud Console die Cloud Deploy Bereitstellungspipelines Seite auf, um Ihre Bereitstellungspipeline aufzurufen („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 Pipelinevisualisierung zeigt den Bereitstellungsstatus der App. Da die Pipeline nur eine Phase hat, zeigt die Visualisierung nur einen Knoten.

   

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

3. Klicken Sie unter Details zur Lieferpipeline auf den Tab Rollouts.

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

   

   Predeploy und Postdeploy werden als Jobs aufgeführt.

5. Klicken Sie auf Predeploy.

   Das Jobausführungsprotokoll wird angezeigt.

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

   

   Beachten Sie textPayload. Dieser String wurde in der predeploy-action in Ihrer Bereitstellungspipeline konfiguriert.

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

   

Bereinigen

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

1. Löschen Sie den GKE-Cluster oder den 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. Löschen Sie die Bereitstellungspipeline, das Ziel, den Release und den Rollout:

   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.

   Einer endet mit _clouddeploy und der andere ist [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

• Erfahren Sie, wie Sie Google Cloud CI/CD-Tools kombinieren, um Software effektiv zu entwickeln und in GKE bereitzustellen.