Anwendung mithilfe von Messwerten analysieren

Anwendung mithilfe von Messwerten analysieren

In dieser Kurzanleitung erfahren Sie, wie Sie mit Cloud Deploy Ihren bereitgestellten Cloud Run-Dienst anhand von Messwerten aus Google Cloud Observability analysieren können, um sicherzustellen, dass die Anwendung wie erwartet funktioniert.

Dieser Schnellstart erläutert folgende Schritte:

1. Einen Cloud Run-Dienst erstellen und bereitstellen.

   In diesem Fall verwenden Sie Cloud Deploy nicht für die Bereitstellung.

2. Eine Verfügbarkeitsdiagnose in Google Cloud Observability erstellen.

   Mit dieser Diagnose wird Ihr Cloud Run-Dienst überwacht, um sicherzustellen, dass er ausgeführt wird.

3. Eine Benachrichtigungsrichtlinie in Cloud Monitoring erstellen.

   Standardmäßig können bei der Cloud Deploy-Analyse viele Arten von Messwerten aus Google Cloud Observability verwendet werden. Mit dieser Richtlinie wird eine Benachrichtigung erstellt, wenn eine Verfügbarkeitsdiagnose ein Problem anzeigt.

4. Eine Skaffold-Konfiguration erstellen, um den Cloud Run-Dienst zu identifizieren.

5. Lieferpipeline und Ziel für Cloud Deploy definieren.

   Diese Pipeline enthält nur eine Phase und verwendet nur ein Ziel. Außerdem enthält sie die Definition für einen Analysejob.

6. Einen Release erstellen, der automatisch für das Ziel bereitgestellt wird.

   Nachdem die Anwendung bereitgestellt wurde, wird die Analyse als Job in dem Roll-out ausgeführt.

   Der Dienst sollte erfolgreich für das Ziel bereitgestellt werden, der Roll-out sollte jedoch fehlschlagen, da die Benachrichtigungsrichtlinie eine Benachrichtigung generiert.

7. Die Cloud Run-Dienstdefinition ändern, um die Anzahl der Instanzen für den Dienst zu erhöhen, und einen neuen Release erstellen.

   Diesmal wird der Dienst erfolgreich bereitgestellt und der Roll-out wird abgeschlossen.

Hinweis

Melden Sie sich in Ihrem Google Cloud Konto an. Wenn Sie noch kein Konto haben, erstellen Sie ein Konto, um zu sehen, wie sich unsere Produkte in realen Szenarien schlagen. Google CloudNeukunden 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

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, 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

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, 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.

Erforderliche Rollen

Damit das Cloud Deploy-Dienstkonto die erforderlichen Berechtigungen zum Ausführen von Cloud Deploy-Vorgängen und zum Bereitstellen in Cloud Run hat, bitten Sie Ihren Administrator, dem Cloud Deploy-Dienstkonto die folgenden IAM-Rollen für Ihr Projekt zu gewähren:

Wichtig: Sie müssen diese Rollen dem Cloud Deploy-Dienstkonto und nicht Ihrem Nutzerkonto zuweisen. Wenn die Rollen nicht dem richtigen Hauptkonto zugewiesen werden, können Berechtigungsfehler auftreten.

• Cloud Run Developer (roles/run.developer)
• Cloud Deploy Runner (roles/clouddeploy.jobRunner)
• IAM Service Account User (roles/iam.serviceAccountUser)
• Monitoring Alert Viewer (roles/monitoring.alertViewer)
• Service Usage Consumer (roles/serviceusage.serviceUsageConsumer)

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Ihr Administrator kann dem Cloud Deploy-Dienstkonto möglicherweise auch die erforderlichen Berechtigungen über benutzerdefinierte Rollen oder andere vordefinierte Rollen erteilen.

Weitere Informationen zum Cloud Deploy-Dienstkonto

Cloud Run-Dienst bereitstellen

In dieser Kurzanleitung wird eine Benachrichtigungsrichtlinie verwendet, für die der Cloud Run-Dienst bereits vorhanden sein muss. Daher stellen wir hier einen bereit und definieren in einem späteren Abschnitt eine service.yaml-Datei mit demselben Dienstnamen.

Führen Sie den folgenden Befehl aus, um den ersten Dienst zu erstellen:

gcloud run deploy my-analysis-run-service \
  --image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a \
  --project=PROJECT_ID \
  --region=us-central1 \
  --allow-unauthenticated

Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

Verfügbarkeitsdiagnose in Google Cloud Observability erstellen

Mit dieser Verfügbarkeitsdiagnose wird Ihr ausgeführter Dienst überwacht, um zu bestätigen, dass er ausgeführt wird. In einem späteren Abschnitt erstellen Sie eine Benachrichtigungsrichtlinie für Google Cloud Observability, die eine Benachrichtigung generiert, wenn für Ihren Dienst nicht mindestens eine verfügbare Instanz ausgeführt wird.

1. Führen Sie den folgenden Befehl aus, um die Verfügbarkeitsdiagnose zu erstellen:

   gcloud monitoring uptime create my-analysis-run-service-cloud-run-uptime-check \
     --resource-type=cloud-run-revision \
     --resource-labels="project_id=PROJECT_ID,location=us-central1,service_name=my-analysis-run-service" \
     --project=PROJECT_ID \
     --protocol=https \
     --path="/" \
     --port=443 \
     --period=1 \
     --timeout=10 \
     --service-agent-auth="oidc-token" \
     --status-classes="2xx"
   

2. Kopieren Sie die ID der Verfügbarkeitsdiagnose.

   Die Ausgabe des gerade ausgeführten Befehls enthält die ID.

Skaffold-Konfiguration und Dienstdefinition vorbereiten

In dieser Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, die das Manifest identifiziert, das zum Bereitstellen des Cloud Run-Beispieldienstes verwendet werden soll. Außerdem definieren Sie die service.yaml-Datei, die den Cloud Run-Dienst selbst definiert.

1. Öffnen Sie ein Terminalfenster.

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

mkdir deploy-analysis-run-quickstart
cd deploy-analysis-run-quickstart

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

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

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

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

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: my-analysis-run-service
  annotations:
    run.googleapis.com/scalingMode: manual
    run.googleapis.com/manualInstanceCount: 0
spec:
  template:
    spec:
      containers:
      - image: my-app-image

Diese Datei ist eine Cloud Run-Dienstdefinition, die zum Bereitstellen der Anwendung verwendet wird. Das bereitzustellende Container-Image wird hier als a Platzhalter, my-app-image, festgelegt, der beim Erstellen des Release durch das spezifische Image ersetzt wird, wenn Sie das Release erstellen.

Der Skalierungsmodus ist auf „Manuell“ und die Anzahl der Instanzen auf 0 festgelegt. Das bedeutet, dass der bereitgestellte Dienst keinen Traffic empfangen kann und keine Instanzen ausgeführt werden, was eine Benachrichtigung auslöst. Diese Benachrichtigung konfigurieren Sie als Nächstes.

Benachrichtigungsrichtlinie erstellen

In dieser Kurzanleitung wird eine Benachrichtigungsrichtlinie für Google Cloud Observability verwendet. Diese Benachrichtigungsrichtlinie generiert eine Benachrichtigung, wenn die Verfügbarkeitsdiagnose für den Cloud Run-Dienst, die Sie zuvor erstellt haben, fehlschlägt.

1. Erstellen Sie im Verzeichnis deploy-analysis-run-quickstart eine Datei mit dem Namen policy.yaml und mit folgendem Inhalt:

   displayName: Cloud Run service uptime check
   userLabels:
     policy-for: analysis-run-pipeline
   combiner: OR
   conditions:
   - displayName: Failure of uptime check UPTIME_ID
     conditionThreshold:
       filter: metric.type="monitoring.googleapis.com/uptime_check/check_passed" AND metric.label.check_id="UPTIME_ID" AND resource.type="cloud_run_revision"
       aggregations:
       - alignmentPeriod: 60s
         crossSeriesReducer: REDUCE_COUNT_FALSE
         groupByFields:
         - resource.label.*
         perSeriesAligner: ALIGN_NEXT_OLDER
       comparison: COMPARISON_GT
       duration: 60s
       thresholdValue: 1.0
   

   Ersetzen Sie UPTIME_ID durch die ID der Verfügbarkeitsdiagnose, die Sie zuvor erstellt haben before.

2. Führen Sie den folgenden Befehl aus, um die Richtlinie zu erstellen:

   gcloud monitoring policies create \
     --policy-from-file=policy.yaml\
     --project=PROJECT_ID
   

   Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

3. Kopieren Sie die Richtlinien-ID aus der Ausgabe des gerade ausgeführten Befehls.

   Kopieren Sie diesmal die gesamte Ressourcen-ID einschließlich des Pfads. Sie verwenden diese ID im nächsten Abschnitt in der Analysekonfiguration in Ihrer Lieferpipeline.

Lieferpipeline und Ziel erstellen

Diese Lieferpipeline hat eine Phase für ein Ziel: analysis-staging.

Hinweis: Sie können Ziele in derselben Konfigurationsdatei wie Ihre Pipeline oder in separaten Dateien definieren. In dieser Kurzanleitung erstellen Sie eine einzelne Datei mit der Pipeline und dem Ziel.

1. Erstellen Sie im Verzeichnis deploy-analysis-run-quickstart eine neue Datei mit dem Namen clouddeploy.yaml und mit folgendem Inhalt:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-analysis-demo-app-run
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: analysis-staging
       profiles: []
       strategy:
         standard:
           analysis:
             duration: 300s
             googleCloud:
               alertPolicyChecks:
               - id: check-1
                 alertPolicies:
                 - ALERT_POLICY_ID
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: analysis-staging
   description: staging Run service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   Ersetzen Sie in dieser YAML-Datei ALERT_POLICY_ID durch die Ausgabe des Befehls gcloud monitoring policies list, den Sie zuvor ausgeführt haben, und ersetzen Sie PROJECT_ID durch die ID des Projekts, das Sie verwenden.

2. Registrieren Sie Ihre Pipeline und Ihr Ziel 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.

3. Bestätigen Sie Pipeline und Ziel:

   Rufen Sie in der Google Cloud Console die Seite Lieferpipelines von Cloud Deploy 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.

   

Release erstellen

Hinweis: Dieser Release soll fehlschlagen. In einem späteren Schritt nehmen Sie eine Änderung vor und erstellen dann einen neuen Release, der erfolgreich sein sollte.

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.

Führen Sie den folgenden Befehl im Verzeichnis deploy-analysis-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-analysis-demo-app-run \
  --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 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 Roll-out-Ressource. Die Anwendung wird automatisch für das eine Ziel bereitgestellt, das für diese Lieferpipeline konfiguriert wurde.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten wird Ihr Release in Ihrer Ziel-Laufzeitumgebung bereitgestellt. Sie können es sich ansehen.

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

   Zur Seite der Lieferpipelines

2. Klicken Sie auf den Namen Ihrer Lieferpipeline („deploy-analysis-demo-app-run“).

   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.

   Analyse wird als Job aufgeführt.

   

Fehlgeschlagene Analyse

Der Analysejob, den wir in der Konfiguration unserer Lieferpipeline angegeben haben, wird im Rahmen dieses Roll-outs ausgeführt, nachdem die Anwendung bereitgestellt wurde. Diese Analyse soll fehlschlagen, da die Benachrichtigungsrichtlinie eine Benachrichtigung auslösen sollte. Der Roll-out schlägt aufgrund dieses Analysefehlers fehl.

Wir nehmen eine Änderung vor und erstellen dann einen weiteren Release, der erfolgreich sein sollte.

Dienstdefinition ändern und neuen Release erstellen

Jetzt ändern wir die Anzahl der Instanzen in der Dienstdefinition, sodass eine Instanz des Dienstes ausgeführt wird und die Benachrichtigung nicht ausgelöst wird.

1. Bearbeiten Sie die Cloud Run-Definitionsdatei service.yaml, um den Wert von run.googleapis.com/manualInstanceCount von 0 in 1 zu ändern.

2. Führen Sie den folgenden Befehl im selben Verzeichnis deploy-analysis-run-quickstart aus, um einen weiteren release zu erstellen:

   gcloud deploy releases create test-release-002 \
     --project=PROJECT_ID \
     --region=us-central1 \
     --delivery-pipeline=deploy-analysis-demo-app-run \
     --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a
   

Diesmal sollte der Roll-out erfolgreich sein. Das liegt daran, dass Ihr Cloud Run-Dienst jetzt eine ausgeführte Instanz hat, sodass die Verfügbarkeitsdiagnose keine Benachrichtigung von der Benachrichtigungsrichtlinie auslöst.

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

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

2. Führen Sie den folgenden Befehl im Verzeichnis mit der Definition Ihrer Lieferpipeline aus, um die Lieferpipeline, das Ziel, den Release und den Roll-out zu löschen:

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

3. Löschen Sie die Benachrichtigungsrichtlinie für Google Cloud Observability:

   gcloud monitoring policies delete  ALERT_POLICY_ID
   

4. 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 Bereitstellungsanalyse.

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