Anwendung nach der Bereitstellung überprüfen

Anwendung nach der Bereitstellung überprüfen

In dieser Kurzanleitung erfahren Sie, wie Sie mit Cloud Deploy Ihre bereitgestellte Anwendung im Rahmen der Bereitstellungspipeline prüfen.

Dieser Schnellstart erläutert folgende Schritte:

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

   Sie können die Bereitstellungsüberprüfung auch für einen GKE Enterprise-Cluster verwenden. In dieser Kurzanleitung 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 konfigurieren Sie den Container für die Deployment-Überprüfung, der nach dem Deployment ausgeführt werden soll.

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

   In der Konfiguration der Bereitstellungspipeline verweisen Sie auf die in skaffold.yaml definierte Bereitstellungsüberprüfung, um diese auszuführen.

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

4. Erstellen Sie einen Release, der automatisch für das Ziel bereitgestellt wird.

   Nachdem die Anwendung bereitgestellt wurde, wird die Bestätigung als Phase des Rollouts ausgeführt.

5. Die Ergebnisse der Überprüfung können Sie in den Cloud Build-Logs auf der Seite Rollout-Details von Cloud Deploy in derGoogle Cloud console ansehen.

Hinweise

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.
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.
Enable the APIs
Install the 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 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 -Konsole 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.

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.

Enable the APIs

Install the 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 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 -Konsole ausführen möchten, verwenden Sie Cloud Shell.

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

gcloud components update

1. Prüfen Sie, ob das Compute Engine-Standarddienstkonto 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-verification-cluster mit den 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-verification-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

Skaffold-Konfiguration und Anwendungsmanifest vorbereiten

Cloud Deploy verwendet Skaffold, um Details dazu anzugeben, was bereitgestellt werden soll und wie die Bereitstellung für Ihr Ziel erfolgen soll.

In dieser Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, in der das Manifest für die Bereitstellung der Beispielanwendung und der Container für die Ausführung nach der Bereitstellung (die Bereitstellungsüberprüfung) angegeben werden.

1. Öffnen Sie ein Terminalfenster.

2. Erstellen Sie ein neues Verzeichnis und rufen Sie es auf.

   GKE

   mkdir deploy-verification-gke-quickstart
   cd deploy-verification-gke-quickstart
   

   Cloud Run

   mkdir deploy-verification-run-quickstart
   cd deploy-verification-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: {}
   verify:
   - name: verification-test
     container:
       name: verification-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "Your test or tests would go here."' ]
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   verify:
   - name: verification-test
     container:
       name: verification-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "Your test or tests would go here."' ]
   

   Diese Datei enthält den verify:-Abschnitt, in dem der Container und der Befehl definiert werden, die nach der Bereitstellung der Anwendung ausgeführt werden sollen. In diesem Fall stellen wir einen Ubuntu-Container bereit und führen einen einfachen echo-Befehl aus. Die Ergebnisse dieses Befehls können Sie in den Logs ansehen. In einem realistischeren Szenario würden Sie Tests für Ihre bereitgestellte Anwendung ausführen.

   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-verification-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 des Releases durch das spezifische 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-verification-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-image festgelegt, der beim Erstellen des Releases durch das spezifische Image ersetzt wird.

Lieferpipeline und Ziele erstellen

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

1. Erstellen Sie Ihre Lieferpipeline und Zieldatei:

   GKE

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-verification-demo-app-gke-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: verify-staging
       profiles: []
       strategy:
         standard:
           verify: true
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: verify-staging
   description: verification staging cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-verification-cluster
   

   Cloud Run

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-verification-demo-app-run-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: verify-staging
       profiles: []
       strategy:
         standard:
           verify: true
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: verify-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 und können Ihre Anwendung bereitstellen und die Bereitstellung überprüfen.

3. Bestätigen Sie Pipeline und Ziele:

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

   Zur Seite der Lieferpipelines

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

   

Release erstellen

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

GKE

Führen Sie den folgenden Befehl im Verzeichnis deploy-verification-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-verification-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 Erstellung von Releases SHA-qualifizierte Image-Namen zu verwenden.

Cloud Run

Führen Sie den folgenden Befehl im Verzeichnis deploy-verification-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-verification-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, die Dienstdefinitionen auf diese Weise zu templatieren und bei der Erstellung von Releases 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 ist.

Der Bestätigungsjob, den wir in unserer Skaffold-Konfiguration angegeben haben, wird im Rahmen dieses Rollouts ausgeführt, nachdem die Anwendung bereitgestellt wurde.

Ergebnisse in der Google Cloud -Console ansehen

Nach einigen Minuten wird Ihr Release in der Ziel-Laufzeitumgebung bereitgestellt.

Der von uns konfigurierte Prüfjob gibt beispielsweise einen String in das Cloud Build-Log aus. Wir können uns dieses Log ansehen, um zu bestätigen, dass die Bestätigung wie erwartet funktioniert hat.

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

   Zur Seite der Lieferpipelines

2. Klicken Sie auf den Namen der Lieferpipeline („deploy-verification-demo-app-gke-1“ oder „deploy-verification-demo-app-run-1“).

   Die Pipeline-Visualisierung zeigt den Bereitstellungsstatus der App. Da die Pipeline nur eine Phase hat, 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 des Roll-outs, um die Roll-out-Details aufzurufen.

   

   Bestätigen wird als Job aufgeführt.

5. Klicken Sie auf Bestätigen.

   Das Joblauf-Log wird angezeigt.

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

   

   Beachten Sie das textPayload. Diese Zeichenfolge wurde im Verify-Abschnitt Ihrer Skaffold-Konfiguration konfiguriert.

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 Cloud Run-Dienst:

   GKE

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

   Cloud Run

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

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

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

3. Löschen Sie die Cloud Storage-Buckets, die von Cloud Deploy erstellt wurden.

   Eine endet mit _clouddeploy und die 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

• Weitere Informationen zur Bereitstellungsüberprüfung

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