Anwendung nach der Bereitstellung prüfen

In dieser Kurzanleitung erfahren Sie, wie Sie mit Cloud Deploy Ihre bereitgestellte als Teil der Bereitstellungspipeline verwendet werden.

Dieser Schnellstart erläutert folgende Schritte:

  1. GKE-Cluster oder Cloud Run erstellen Service.

    Sie können die Deployment-Überprüfung auch für einen GKE Enterprise-Cluster verwenden, aber das In der Kurzanleitung werden 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 zur Überprüfung des Deployments, der nach dem Deployment ausgeführt werden soll.

  3. Cloud Deploy-Bereitstellungspipeline und -Deployment definieren Ziel.

    In der Konfiguration der Bereitstellungspipeline verweisen Sie auf die Bereitstellung die in skaffold.yaml definiert ist, um diese Überprüfung durchzuführen.

    Diese Pipeline umfasst nur eine Phase und verwendet nur ein Ziel.

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

    Nachdem die Anwendung bereitgestellt wurde, verification wird als Phase des Einführung.

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

Hinweise

  1. 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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

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

    Enable the APIs

  5. Install the Google Cloud CLI.
  6. To initialize the gcloud CLI, run the following command:

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

    Go to project selector

  8. Make sure that billing is enabled for your Google Cloud project.

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

    Enable the APIs

  10. Install the Google Cloud CLI.
  11. To initialize the gcloud CLI, run the following command:

    gcloud init
  12. Wenn Sie die Befehlszeile bereits installiert haben, prüfen Sie, ob Sie die neueste Version verwenden:

    gcloud components update
    

  13. Achten Sie darauf, dass das Compute Engine-Standarddienstkonto ausreichend Berechtigungen hat.

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

    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 die jeweilige 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 enthält die Berechtigung actAs zur Bereitstellung in der Laufzeit:

      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 eine Bereitstellung in Cloud Run vornehmen, 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 die über das öffentliche Internet erreichbar sind. 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 nutzt Skaffold, um was Sie bereitstellen und wie Sie diese auf Ihrem target angeben.

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

  1. Öffnen Sie ein Terminalfenster.

  2. Erstellen Sie ein neues Verzeichnis und wechseln Sie zu diesem 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 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 verify:-Stanza, mit der der Container und der Befehl definiert werden. die nach der Bereitstellung der Anwendung ausgeführt werden sollen. In diesem Fall stellen wir eine Ubuntu-Container mit einem einfachen echo-Befehl. Sie können die Ergebnisse dieses Befehls in den Logs. In einem realistischeren Szenario würden Sie Tests für die bereitgestellte Anwendung ausführen

    Siehe Referenz zu skaffold.yaml finden Sie weitere Informationen zu dieser Konfigurationsdatei.

  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, der bei der Bereitstellung zum Erstellen von Cloud Run verwendet wird Service.

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 Lieferpipeline 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 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 überprüfen Sie die Bereitstellung.

  3. Bestätigen Sie Pipeline und Ziele:

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

    Zur Seite der Lieferpipelines

    Die soeben erstellte Bereitstellungspipeline wird angezeigt, wobei ein Ziel in Spalte Ziele

    Seite der Bereitstellungspipeline in der Google Cloud Console mit der Pipeline

Release erstellen

Ein Release ist die zentrale Cloud Deploy-Ressource, die den Änderungen bereitgestellt werden. Die Bereitstellungspipeline definiert den Lebenszyklus Veröffentlichung. Weitere Informationen zu diesem Lebenszyklus finden Sie unter Cloud Deploy-Dienstarchitektur.

GKE

Führen Sie 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

Cloud Run

Führen Sie den folgenden Befehl über die deploy-verification-run-quickstart aus. Verzeichnis zum Erstellen einer release-Ressource, die den Container darstellt bereitzustellendes Image:

 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:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

Wie bei allen Releases (außer sie enthalten --disable-initial-rollout): Cloud Deploy erstellt automatisch eine rollout-Ressource hinzu. Die Anwendung wird automatisch für das für diese Bereitstellungspipeline konfigurierte Ziel bereitgestellt.

Der in der Skaffold-Konfiguration angegebene Verifizierungsjob wird nachdem die Anwendung bereitgestellt wurde.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten ist der Release in Ihrer Ziellaufzeit bereitgestellt.

Der von uns konfigurierte Überprüfungsjob (z. B. Zwecke) gibt einen String aus in das Cloud Build-Log ein. Wir können dieses Protokoll aufrufen, um zu bestätigen, wie erwartet funktioniert.

  1. Rufen Sie in der Google Cloud Console Cloud Deploy auf. Seite Bereitstellungspipelines zur Anzeige der Bereitstellungspipeline („deploy-verification-demo-app-gke-1“ oder „deploy-verification-demo-app-run-1“)

    Zur Seite der Lieferpipelines

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

    Die Pipeline-Visualisierung zeigt den Bereitstellungsstatus der Anwendung. Weil es nur eine Phase in der Pipeline hat, wird in der Visualisierung nur ein Knoten angezeigt.

    Visualisierung der Bereitstellungspipeline

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

  3. Klicken Sie unter Details zur Bereitstellungspipeline auf den Tab Einführungen.

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

    Roll-outs in der Google Cloud Console

    Verify wird als Job aufgeführt.

  5. Klicken Sie auf Bestätigen.

    Das Jobausführungslog wird angezeigt.

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

    Logeintrag mit der Ausgabe des Jobs „Überprüfen“

    Beachten Sie die textPayload. Dieser String wurde im Verify Stanza in deinem Skaffold-Konfiguration.

Bereinigen

Mit den folgenden Schritten vermeiden Sie, dass Ihrem Google Cloud-Konto die in dieser Anleitung 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 von Cloud Deploy erstellten Cloud Storage-Buckets.

    Eine endet auf _clouddeploy und die andere [region].deploy-artifacts.[project].appspot.com.

    Die Cloud Storage-Browserseite öffnen

Das war alles. Sie haben diesen Schnellstart abgeschlossen!

Nächste Schritte