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 in einem 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 Bereitstellungsüberprüfung, der nach der Bereitstellung ausgeführt werden soll.

  3. Definieren Sie die Bereitstellungspipeline und das Bereitstellungsziel von Cloud Deploy.

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

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

  4. Erstellen Sie einen Release, der automatisch auf dem Ziel bereitgestellt wird.

    Nach der Bereitstellung der Anwendung erfolgt die Überprüfung als Phase des Roll-outs.

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

Hinweise

  1. Melden Sie sich bei Ihrem Google Cloud-Konto an. Wenn Sie mit Google Cloud noch nicht vertraut sind, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

  2. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  3. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

  4. Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs aktivieren.

    Aktivieren Sie die APIs

  5. Installieren Sie die Google Cloud CLI.

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

    gcloud init
    7.

  7. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  8. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

  9. Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs aktivieren.

    Aktivieren Sie die APIs

  10. Installieren Sie die Google Cloud CLI.

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

    gcloud init
    12.

    Wenn Sie die Befehlszeile bereits installiert haben, prüfen Sie, ob es sich um die neueste Version handelt: 

    gcloud components update

  12. Prüfen Sie, ob das Compute Engine-Standarddienstkonto die erforderlichen Berechtigungen hat.

    Das Dienstkonto hat möglicherweise bereits die erforderlichen Berechtigungen. Diese Schritte sind für Projekte enthalten, bei denen automatische Rollenzuweisungen für Standarddienstkonten deaktiviert werden.

    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)")-compute@developer.gserviceaccount.com \
    --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)")-compute@developer.gserviceaccount.com \
    --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)")-compute@developer.gserviceaccount.com \
    --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)")-compute@developer.gserviceaccount.com \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/iam.serviceAccountUser" \
    --project=PROJECT_ID

Laufzeitumgebung erstellen

Wenn Sie die Bereitstellung in Cloud Run durchführen, können Sie diesen Befehl überspringen.

Erstellen Sie für GKE einen Cluster: deploy-verification-cluster mit Standardeinstellungen. Der Kubernetes API-Endpunkt des Clusters muss über das öffentliche Internet im Netzwerk 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 für die Bereitstellung und die Bereitstellung für Ihr Ziel bereitzustellen.

In dieser Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, in der das Manifest für die Bereitstellung der Beispielanwendung und der Container identifiziert werden, der nach der Bereitstellung ausgeführt werden soll (Bereitstellungsprüfung).

  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 die Stanza verify:, mit der der Container und der Befehl definiert werden, der nach der Bereitstellung der Anwendung ausgeführt werden soll. 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 einsehen. In einem realistischeren Szenario würden Sie Tests für Ihre bereitgestellte Anwendung ausführen.

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

  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.

    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 Zeitpunkt der Bereitstellung verwendet wird, um Ihren Cloud Run-Dienst zu erstellen.

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 die Bereitstellungspipeline und die Zieldefinition:

    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

  2. Registrieren Sie Ihre Pipeline und Ziele mit dem Cloud Deploy-Dienst:

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

    Sie haben jetzt eine Bereitstellungspipeline mit einem Ziel, die bereit ist, Ihre Anwendung bereitzustellen und diese Bereitstellung zu prüfen.

  3. Bestätigen Sie Pipeline und Ziele:

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

    Zur Seite der Lieferpipelines

    Die soeben erstellte Bereitstellungspipeline wird angezeigt, mit einem Ziel in der Spalte Ziele.

    Seite „Bereitstellungspipeline“ in der Google Cloud Console, auf der Ihre Pipeline angezeigt wird

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 im Verzeichnis deploy-verification-gke-quickstart den folgenden Befehl 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

Cloud Run

Führen Sie im Verzeichnis deploy-verification-run-quickstart den folgenden Befehl 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:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc

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

Der Verifizierungsjob, den wir in der 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 der Release in der Ziellaufzeit bereitgestellt.

Der Verifizierungsjob, den wir beispielsweise konfiguriert haben, gibt einen String im Cloud Build-Log aus. Wir können uns dieses Protokoll ansehen, um zu bestätigen, dass die Verifizierung wie erwartet funktioniert.

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

    Zur Seite der Lieferpipelines

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

    Die Pipelinevisualisierung zeigt den Bereitstellungsstatus der Anwendung. Da es in der Pipeline nur eine Phase gibt, zeigt die Visualisierung nur einen Knoten.

    Visualisierung der Bereitstellungspipeline, die Erfolg zeigt

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

  3. Klicken Sie unter Details zur Bereitstellungspipeline auf den Tab Roll-outs.

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

    Roll-outs in der Google Cloud Console

    Verify ist als Job aufgeführt.

  5. Klicken Sie auf Bestätigen.

    Das Log für die Jobausführung wird angezeigt.

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

    Logeintrag, der die Ausgabe des Jobs „Verify“ anzeigt

    Beachten Sie die textPayload. Dieser String wurde in der Stanza Verify in der 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 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 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 Cloud Storage-Buckets, die von Cloud Deploy erstellt wurden.

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