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 überprüfen.

Dieser Schnellstart erläutert folgende Schritte:

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

   Sie können die Bereitstellungsprüfung auch für 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 Bereitstellungspipeline enthält nur eine Phase und verwendet nur ein Ziel. Sie definieren die Konfiguration für die Bereitstellungsprüfung im Abschnitt stage.

3. Erstellen Sie eine Skaffold-Konfiguration, die für den Release erforderlich ist, und entweder ein Kubernetes -Manifest oder eine Cloud Run-Dienstdefinition.

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

   Nachdem die Anwendung bereitgestellt wurde, wird die Überprüfung als Phase des Roll-outs ausgeführt.

5. Rufen Sie die Ergebnisse der Überprüfung in den Cloud Build-Logs auf. Verwenden Sie dazu in der Console die Cloud Deploy-Seite Roll-out-Details. Google Cloud

Hinweis

Melden Sie sich in Ihrem Google Cloud Konto an. Wenn Sie noch kein Google Cloud-Konto haben, erstellen Sie eines, um zu sehen, wie sich unsere Produkte in realen Szenarien schlagen. 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-verification-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-verification-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

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

2. Erstellen Sie ein neues Verzeichnis und wechseln Sie in dieses Verzeichnis.

   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 die Definition für die Lieferpipeline und das Ziel:

   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:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "Your test or tests would go here."' ]
   ---
   
   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:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "Your test or tests would go here."' ]
   ---
   
   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.

   Diese Datei enthält den Abschnitt verify in der Definition strategy der Lieferpipeline. Darin werden der Container und der Befehl definiert, 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.

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 Lieferpipeline mit einem Ziel und können Ihre Anwendung bereitstellen und die Bereitstellung überprüfen.

5. Bestätigen Sie Pipeline und Ziele:

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

   Zur Seite der Lieferpipelines

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

   

Skaffold-Konfigurationsdatei und Anwendungsmanifest erstellen

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

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-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 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-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-imagefestgelegt, der beim Erstellen des Release durch das spezifische Image ersetzt wird.

Release erstellen

Ein Release ist die zentrale Cloud Deploy-Ressource, die die bereitzustellenden Änderungen darstellt. Die Lieferpipeline definiert den Lebenszyklus dieses Release. 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 beim Erstellen des Release 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 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, Ihre Dienstdefinitionen auf diese Weise zu templatieren und beim Erstellen des Release SHA-qualifizierte Image-Namen zu verwenden.

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

Der Überprüfungsjob, den wir in unserer Lieferpipeline angegeben haben, wird im Rahmen dieses Roll-outs ausgeführt, nachdem die Anwendung bereitgestellt wurde.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten wird Ihr Release in Ihrer Ziellaufzeit bereitgestellt.

Der von uns konfigurierte Überprüfungsjob gibt (zu Testzwecken) einen String in das Cloud Build-Log aus. Wir können dieses Log aufrufen, um zu bestätigen, dass die Überprüfung wie erwartet funktioniert hat.

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

   Zur Seite der Lieferpipelines

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

   Die Pipelinevisualisierung 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.

   

   Überprüfen wird als Job aufgeführt.

5. Klicken Sie auf Überprüfen.

   Das Jobausführungsprotokoll wird angezeigt.

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

   

   Beachten Sie textPayload. Dieser String wurde im Verify Abschnitt in Ihrer Lieferpipeline 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 den 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 Lieferpipeline, das Ziel, den 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.

   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.

• Weitere Informationen zur Bereitstellungsprüfung.

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