Release-Hochstufung und Roll-out-Fortschritt in Cloud Deploy automatisieren

Release-Hochstufung und Roll-out-Fortschritt in Cloud Deploy automatisieren

Experimentell

Dieses Produkt oder diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Produkte und -Funktionen sind unverändert verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

Auf dieser Seite erfahren Sie, wie Sie mit Cloud Deploy einen Release automatisch auf ein Ziel hochstufen und ein Roll-out in die nächste Phase übergehen.

Dieser Schnellstart erläutert folgende Schritte:

1. Erstellen Sie zwei GKE-Cluster oder zwei Cloud Run-Dienste.

2. Erstellen Sie eine Skaffold-Konfiguration und entweder ein Kubernetes-Manifest oder eine Cloud Run-Dienstdefinition.

3. Definieren Sie Ihre Cloud Deploy-Bereitstellungspipeline und Deployment-Ziele.

   Die Pipeline wird auf zwei Zielen bereitgestellt: dev und staging. Und das Ziel staging verwendet eine Canary-Bereitstellungsstrategie.

4. Definieren Sie zwei Automatisierungsregeln:

   • Eine Automatisierung, um den Release bei einem erfolgreichen Roll-out bei dev in das Ziel staging hochzustufen.

   • Eine Automatisierung, um das Roll-out nach erfolgreichem Abschluss der canary-25-Phase in die stable-Phase zu überleiten.

5. Instanziieren Sie Ihre Bereitstellungspipeline. Erstellen Sie dazu einen Release, der automatisch im Ziel dev bereitgestellt wird.

6. Sehen Sie sich die Bereitstellungspipeline und den Release in der Google Cloud Console an.

   Aufgrund der automatischen Hochstufung wird dieser Release automatisch in den staging hochgestuft.

   Da das Ziel staging eine Canary-Bereitstellungsstrategie verwendet und dies die erste Bereitstellung in dieser Laufzeit ist, wird die Phase canary-25 übersprungen. Unter Warum Phasen manchmal übersprungen werden erfahren Sie, warum die Canary-Phase beim ersten Mal übersprungen wird.

   Aufgrund des automatisierten Phasenfortschritts geht der Roll-out in die stable-Phase über.

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.

   Hinweis: Wenn Sie die Ressourcen, die Sie in diesem Verfahren erstellen, nicht behalten möchten, erstellen Sie ein Projekt, anstatt ein vorhandenes Projekt auszuwählen. Wenn Sie fertig sind, können Sie das Projekt löschen und dadurch alle mit dem Projekt verknüpften Ressourcen entfernen.

   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

   Hinweis: Sie können die gcloud CLI in der Google Cloud Console ausführen, ohne die Google Cloud CLI zu installieren. Verwenden Sie Cloud Shell, um die gcloud CLI in der Google Cloud Console auszuführen.

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

   Hinweis: Wenn Sie die Ressourcen, die Sie in diesem Verfahren erstellen, nicht behalten möchten, erstellen Sie ein Projekt, anstatt ein vorhandenes Projekt auszuwählen. Wenn Sie fertig sind, können Sie das Projekt löschen und dadurch alle mit dem Projekt verknüpften Ressourcen entfernen.

   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

    Hinweis: Sie können die gcloud CLI in der Google Cloud Console ausführen, ohne die Google Cloud CLI zu installieren. Verwenden Sie Cloud Shell, um die gcloud CLI in der Google Cloud Console auszuführen.

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, 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 Rolle clouddeploy.releaser hinzu:

       gcloud projects add-iam-policy-binding PROJECT_ID \
           --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
           --format="value(projectNumber)")[e-mail] \
           --role="roles/clouddeploy.releaser"
       

    3. 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"
      

    4. Fügen Sie die Rolle iam.serviceAccountUser hinzu, die die Berechtigung actAs für das Standarddienstkonto zur Bereitstellung 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
       

    5. Fügen Sie die Rolle iam.serviceAccountUser mit der Berechtigung actAs für sich selbst hinzu, um das Standarddienstkonto zu verwenden:

       gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
           --format="value(projectNumber)")[e-mail] \
           --member=user:YOUR_EMAIL_ADDRESS \
           --role="roles/iam.serviceAccountUser" \
           --project=PROJECT_ID
       

       In diesem Fall ist YOUR_EMAIL_ADDRESS die E-Mail-Adresse, mit der Sie auf Google Cloud zugreifen.

Laufzeitumgebungen erstellen

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

Erstellen Sie für GKE zwei Cluster: automation-quickstart-cluster-dev und automation-quickstart-cluster-staging mit Standardeinstellungen. Die Kubernetes API-Endpunkte der Cluster müssen über das öffentliche Internet im Netzwerk erreichbar sein. GKE-Cluster sind standardmäßig extern zugänglich.

gcloud container clusters create-auto automation-quickstart-cluster-dev \
                 --project=PROJECT_ID \
                 --region=us-central1 \
                 && gcloud container clusters create-auto automation-quickstart-cluster-staging \
                 --project=PROJECT_ID \
                 --region=us-central1

Rufen Sie Ihre Projektnummer ab.

Sie benötigen Ihre Projektnummer, um das Standarddienstkonto zu identifizieren. Dies ist für die Konfiguration der Automatisierungsressource erforderlich.

1. Führen Sie den folgenden Befehl aus, um Ihre Projektnummer abzurufen:

   gcloud projects describe PROJECT_ID
   

2. Kopieren Sie die Projektnummer aus der Befehlszeilenausgabe und fügen Sie sie hier ein.

   Sie müssen diesen Befehl nicht als Befehl ausführen. Wenn Sie ihn hier einfügen, wird später in dieser Kurzanleitung die Dienstkontoreferenz in der Automatisierungskonfiguration eingefügt.

   PROJECT_NUMBER
   

Skaffold-Konfiguration und Anwendungsmanifest vorbereiten

Cloud Deploy verwendet Skaffold, um die Details für die Bereitstellung und die ordnungsgemäße Bereitstellung für Ihre separaten Ziele bereitzustellen.

In dieser Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, die das Anwendungsmanifest angibt, das zum Bereitstellen der Beispiel-App verwendet werden soll.

1. Öffnen Sie ein Terminalfenster.

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

   GKE

   mkdir deploy-automation-gke-quickstart
   cd deploy-automation-gke-quickstart
   

   Cloud Run

   mkdir deploy-automation-run-quickstart
   cd deploy-automation-run-quickstart
   

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

   GKE

   apiVersion: skaffold/v3alpha1
   kind: Config
   metadata:
     name: gke-automation
   manifests:
     rawYaml:
     - k8s-deployment.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v3alpha1
   kind: Config
   metadata:
     name: run-automation
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-dev.yaml
   - name: staging
     manifests:
       rawYaml:
       - run-staging.yaml
   deploy:
     cloudrun: {}
   

   Diese Datei ist eine minimale Skaffold-Konfiguration. Für diese Kurzanleitung erstellen Sie die Datei. Sie können aber auch eine von Cloud Deploy erstellte App für Sie erstellen lassen, um einfache Anwendungen zu erstellen, die nicht Teil der Produktion sind.

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

4. Erstellen Sie die Definition für Ihre Anwendung – ein Paar Dienstdefinitionen für Cloud Run oder ein Kubernetes-Manifest für GKE.

   GKE

   Erstellen Sie eine Datei mit dem Namen k8s-deployment.yaml und folgendem Inhalt:

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
     labels:
       app: my-app
     namespace: default
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
       spec:
         containers:
         - name: nginx
           image: my-app-image
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: my-service
     namespace: default
   spec:
     selector:
       app: my-app
     ports:
       - protocol: TCP
         port: 80
   

   Diese Datei ist ein einfaches Kubernetes-Manifest, das zum Bereitstellen der Anwendung auf den Cluster angewendet wird.

   Cloud Run

   1. Erstellen Sie eine Datei mit dem Namen run-dev.yaml und folgendem Inhalt:

      apiVersion: serving.knative.dev/v1
      kind: Service
      metadata:
        name: my-automation-run-service-dev
      spec:
        template:
          spec:
            containers:
            - image: my-app-image
      

   2. Erstellen Sie eine Datei mit dem Namen run-staging.yaml und folgendem Inhalt:

      apiVersion: serving.knative.dev/v1
      kind: Service
      metadata:
        name: my-automation-run-service-staging
      spec:
        template:
          spec:
            containers:
            - image: my-app-image
      

   Diese Datei ist eine einfache Cloud Run-Dienstdefinition, die bei der Bereitstellung verwendet wird, um Ihren Cloud Run-Dienst zu erstellen.

Bereitstellungspipeline, Ziele und Automatisierung erstellen

Sie können Ihre Bereitstellungspipeline und -ziele in einer Datei oder in separaten Dateien definieren. Sie können eine Automatisierungsaktion auch in einer separaten Datei definieren. In dieser Kurzanleitung wird eine Datei für die Pipeline, Ziele und Automatisierung verwendet.

1. Erstellen Sie Ihre Bereitstellungspipeline, Zieldefinitionen und Automatisierungsaktion:

   GKE

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-automation-demo-app-1
   description: Automation demonstration pipeline
   serialPipeline:
     stages:
     - targetId: automation-quickstart-dev
     - targetId: automation-quickstart-staging
       profiles: []
       strategy:
         canary:
           runtimeConfig:
             kubernetes:
               serviceNetworking:
                 service: "my-service"
                 deployment: "my-deployment"
           canaryDeployment:
             percentages: [25]
             verify: false
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-dev
   description: Dev cluster to demonstrate deploy automation
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-dev
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-staging
   description: Staging cluster to demonstrate deploy automation
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-staging
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/promote
   description: promotes a release
   suspended: false
   serviceAccount: [e-mail]
   selector:
   - target:
       id: automation-quickstart-dev
   rules:
   - promoteRelease:
       name: "promote-release"
       wait: 1m
       toTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: [e-mail]
   selector:
   - target:
       id: automation-quickstart-staging
   rules:
   - advanceRollout:
       name: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Hinweis: In dieser Datei sind die Ziele und die Konfiguration der Automatisierungen in der Bereitstellungspipeline enthalten. Sie können jedoch Ziele in einer separaten Datei oder in mehreren separaten Dateien und Automatisierungen in einer oder mehreren separaten Dateien definieren.

   Cloud Run

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-automation-demo-app-1
   description: Automation demonstration pipeline
   serialPipeline:
     stages:
     - targetId: automation-quickstart-dev
       profiles: [dev]
     - targetId: automation-quickstart-staging
       profiles: [staging]
       strategy:
         canary:
           runtimeConfig:
             cloudRun:
               automaticTrafficControl: true
           canaryDeployment:
             percentages: [25]
             verify: false
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-dev
   description: Dev cluster to demonstrate deploy automation
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-staging
   description: Staging cluster to demonstrate deploy automation
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/promote
   description: Promotes a release to the next target
   suspended: false
   serviceAccount: [e-mail]
   selector:
   - target:
       id: automation-quickstart-dev
   rules:
   - promoteRelease:
       name: "promote-release"
       wait: 1m
       toTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: [e-mail]
   selector:
   - target:
       id: automation-quickstart-staging
   rules:
   - advanceRollout:
       name: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Hinweis: In dieser Datei sind die Ziele und die Konfiguration der Automatisierungen in der Bereitstellungspipeline enthalten. Sie können jedoch Ziele in einer separaten Datei oder in mehreren separaten Dateien und Automatisierungen in einer separaten Datei oder 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 Pipeline mit einem Multi-Ziel, das aus zwei GKE- oder Cloud Run-Zielen besteht, und ist bereit, Ihre Anwendung bereitzustellen.

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. In der Spalte Ziele sind zwei Ziele aufgeführt.

   

4. Klicken Sie auf den Pipelinenamen, um die Visualisierung und die Details der Bereitstellungspipeline zu öffnen.

5. Wählen Sie unter Details zur Bereitstellungspipeline den Tab Automatisierungen aus.

   Die beiden von Ihnen erstellten Automatisierungen werden angezeigt.

   

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 den folgenden Befehl im Verzeichnis deploy-automation-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=my-automation-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Cloud Run

Führen Sie den folgenden Befehl im Verzeichnis deploy-automation-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=my-automation-demo-app-1 \
   --images=my-app-image=gcr.io/cloudrun/hello@sha256:7c0aeb55b25b12c656ad0856b13126ca0346c16dc631d9d7fa9dc335dd4a05df

Wenn Sie einen Release erstellen, wird standardmäßig automatisch ein Roll-out für das erste Ziel in Ihrer Pipeline erstellt.

Da diese Kurzanleitung zwei Automatisierungen enthält, passieren automatisch zwei Dinge:

• Nach einer erfolgreichen Bereitstellung im ersten Ziel wird der Release automatisch zum zweiten Ziel hochgestuft.

  Für die automatische Werbung gilt eine Wartezeit von einer Minute.

• Im zweiten Ziel, für das eine Canary-Version von 25% konfiguriert ist, wird mit der zweiten Automatisierung das Roll-out von canary-25 auf stable fortgesetzt.

  Bei diesem ersten Release wird die Phase canary-25 übersprungen, da keine bereits vorhandene Version der Anwendung für die Canary-Version vorhanden ist. Der Roll-out wird automatisch auf stable übertragen.

  Bei der erweiterten Automatisierung gibt es eine Verzögerung von einer Minute.

Wenn alles abgeschlossen ist, wird die Anwendung für beide Ziele bereitgestellt, ohne dass Sie weitere Schritte ausführen müssen.

Wenn Sie mehr über die Ausführung einer Canary-Bereitstellungsstrategie erfahren möchten, können Sie die Canary-Kurzanleitung ausprobieren.

Ergebnisse in der Google Cloud Console ansehen

Sie können die Ergebnisse, einschließlich der Automatisierungsausführungen, in der Google Cloud Console ansehen.

1. Rufen Sie die Cloud Deploy-Seite Bereitstellungspipelines auf, um Ihre Bereitstellungspipeline anzusehen.

   Zur Seite der Lieferpipelines

2. Klicken Sie auf den Namen der Bereitstellungspipeline „my-automation-demo-app-1“.

   Die Pipelinevisualisierung zeigt den Bereitstellungsstatus der Anwendung. Wenn genügend Zeit verstrichen ist, werden beide Ziele grün angezeigt.

   

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

3. Klicken Sie auf den Tab Automatisierungsausführungen.

   Es gibt zwei Einträge, einen für jede der beiden automatisierten Abläufe, die Sie erstellt haben. Sie können auf eine der beiden Optionen klicken, um die Details der entsprechenden Automatisierungsausführung anzusehen.

   

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 die GKE-Cluster oder Cloud Run-Dienste:

   GKE

   gcloud container clusters delete automation-quickstart-cluster-dev --region=us-central1 --project=PROJECT_ID \
   && gcloud container clusters delete automation-quickstart-cluster-staging --region=us-west1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-automation-run-service-dev --region=us-central1 --project=PROJECT_ID \
   && gcloud run services delete my-automation-run-service-staging --region=us-central1 --project=PROJECT_ID
   

2. Löschen Sie die Bereitstellungspipeline, Ziele, Automatisierungen, Release und Roll-outs:

   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.

   Das eine endet mit _clouddeploy, das andere auf [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

• Machen Sie sich mit den Grundlagen der Anwendungsbereitstellung vertraut.

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

• Hier erfahren Sie, wie Sie Google Cloud-CI/CD-Tools kombinieren, um Software effektiv zu entwickeln und in GKE bereitzustellen.