Hochstufen von Releases und Fortsetzen von Roll-outs in Cloud Deploy automatisieren

Auf dieser Seite erfahren Sie, wie Sie mit Cloud Deploy ein automatisches Hochstufen für ein Ziel freigeben und ein Roll-out in der nächsten Phase fortsetzen.

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. Cloud Deploy-Bereitstellungspipeline und -Deployment definieren Ziele.

    Die Pipeline wird auf zwei Ziele bereitgestellt: dev und staging. Für das Ziel staging wird eine Canary-Bereitstellungsstrategie verwendet.

  4. Definieren Sie zwei Automatisierungsregeln:

    • Eine Automatisierung, mit der der Release zum Ziel staging hochgestuft wird erfolgreiches Roll-out für dev.

    • Eine Automatisierung, die das Roll-out nach Abschluss der Phase canary-25 in die Phase stable fortsetzt.

  5. Instanziieren Sie Ihre Bereitstellungspipeline. Dazu erstellen Sie einen Release, der automatisch für das dev-Ziel bereitgestellt wird.

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

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

    Da das Ziel staging eine Canary-Bereitstellungsstrategie verwendet und ist die erste Bereitstellung in dieser Laufzeit, wird die canary-25-Phase übersprungen. Weitere Informationen finden Sie unter Warum Phasen manchmal übersprungen werden um mehr darüber zu erfahren, warum die Canary-Phase das erste Mal übersprungen wird.

    Aufgrund der automatisierten Fortsetzung der Phase wird die Einführung stable.

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, achten Sie darauf, dass Sie die neueste Version:

    gcloud components update
    
  13. 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 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. Die clouddeploy.releaser-Rolle hinzufügen:
      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.releaser"
      
    3. 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"
        
    4. Fügen Sie die Rolle iam.serviceAccountUser hinzu, die die Berechtigung actAs für das Standarddienstkonto zum stellen Sie sie in der Laufzeit bereit:
      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
      
    5. Fügen Sie sich die Rolle iam.serviceAccountUser mit der Berechtigung actAs hinzu, um das Standarddienstkonto zu verwenden:
      gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --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

Laufzeitumgebungen erstellen

Wenn Sie eine Bereitstellung in Cloud Run vornehmen, können Sie diesen Befehl überspringen.

Erstellen Sie für GKE zwei Cluster: automation-quickstart-cluster-dev und automation-quickstart-cluster-staging mit den Standardeinstellungen. Die Cluster Kubernetes API-Endpunkte müssen öffentlich erreichbar sein Internet. GKE-Cluster sind extern zugänglich für Standardeinstellung.

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 ausführen. Wenn Sie es hier einfügen, wird das Feld Dienstkontoreferenz in der Automatisierungskonfiguration weiter unten in dieser Kurzanleitung.

    PROJECT_NUMBER
    

Skaffold-Konfiguration und Anwendungsmanifest vorbereiten

Cloud Deploy verwendet Skaffold, um die Details für was Sie bereitstellen sollten und wie Sie es für Ihre separate Ziele.

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

  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/v4beta7
    kind: Config
    metadata:
      name: gke-automation
    manifests:
      rawYaml:
      - k8s-deployment.yaml
    deploy:
      kubectl: {}
    

    Cloud Run

    apiVersion: skaffold/v4beta7
    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 erstellen lassen, für einfache Nicht-Produktionsumgebungen.

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

  4. Erstellen Sie die Definition für Ihre Anwendung – ein Dienstpaar für Cloud Run oder ein Kubernetes-Manifest 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 auf den Cluster angewendet wird, um die Anwendung bereitzustellen.

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

Bereitstellungspipeline, Ziele und Automatisierung erstellen

Sie können die Bereitstellungspipeline und Ziele in einer Datei oder in separaten Dateien definieren -Dateien. Sie können eine Automatisierungsaktion auch in einer separaten Datei definieren. Dieses Für die Pipeline, die Ziele und die Automatisierung wird in der Kurzanleitung nur eine Datei verwendet.

  1. Erstellen Sie Ihre Bereitstellungspipeline, Zieldefinitionen und Automatisierungsaktionen:

    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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
    selector:
      targets:
      - id: automation-quickstart-dev
    rules:
    - promoteReleaseRule:
        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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
    selector:
      targets:
      - id: automation-quickstart-staging
    rules:
    - advanceRolloutRule:
        name: "advance-rollout"
        sourcePhases: ["canary-25"]
        wait: 1m
    

    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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
    selector:
      targets:
      - id: automation-quickstart-dev
    rules:
    - promoteReleaseRule:
        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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
    selector:
      targets:
      - id: automation-quickstart-staging
    rules:
    - advanceRolloutRule:
        name: "advance-rollout"
        sourcePhases: ["canary-25"]
        wait: 1m
    
  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 nun eine Pipeline mit mehreren Zielen, GKE- oder Cloud Run-Ziele, die sofort bereitgestellt werden können Ihre Anwendung.

  3. Bestätigen Sie Pipeline und Ziele:

    Rufen Sie in der Google Cloud Console Cloud Deploy auf. Seite Bereitstellungspipelines zur Liste der verfügbaren Bereitstellungspipelines Pipelines.

    Zur Seite der Lieferpipelines

    Die soeben erstellte Bereitstellungspipeline wird angezeigt. In der Spalte Ziele sind zwei Ziele aufgeführt.

    Visualisierung der Bereitstellungspipeline in der Google Cloud Console

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

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

    Die beiden automatisierten Abläufe, die Sie erstellt haben, werden angezeigt.

    Visualisierung der Bereitstellungspipeline in der Google Cloud Console

Release erstellen

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

GKE

Führen Sie den folgenden Befehl über die deploy-automation-gke-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=my-automation-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Cloud Run

Führen Sie den folgenden Befehl über die deploy-automation-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=my-automation-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

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 zwei Dinge automatisch:

  • Nach einer erfolgreichen Bereitstellung im ersten Ziel wird der Release automatisch auf das zweite Ziel hochgestuft wird.

    Für die Automatisierung des Angebots gibt es eine Wartezeit von einer Minute.

  • Im zweiten Ziel, für das ein Canary-Wert von 25% konfiguriert ist, Automatisierung setzt das Roll-out von canary-25 auf stable fort.

    Bei diesem ersten Release wird die Phase canary-25 übersprungen, da es keine für einen erneuten Canary-Test verwenden. Die Einführung ist automatisch zu stable weitergeleitet.

    Bei der erweiterten Automatisierung kommt es zu einer Verzögerung von einer Minute.

Wenn alles fertig ist, wird die Anwendung erfolgreich in beiden ohne weitere Maßnahmen ergreifen zu müssen.

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

Ergebnisse in der Google Cloud Console ansehen

Sie können die Ergebnisse, einschließlich der Automatisierungsläufe, in der Google Cloud Console aufrufen.

  1. Rufen Sie in Cloud Deploy die Seite Bereitstellungspipelines auf, um es sich anzusehen Ihrer Bereitstellungspipeline.

    Zur Seite der Lieferpipelines

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

    Die Pipeline-Visualisierung zeigt den Bereitstellungsstatus der Anwendung. Nach ausreichender Zeit werden beide Ziele grün angezeigt.

    Visualisierung der Bereitstellungspipeline in der Google Cloud Console

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

  3. Klicken Sie auf den Tab Automatisierungsläufe.

    Es gibt zwei Einträge, einen für jede der beiden von Ihnen erstellten Automatisierungen. Ich können Sie auf eines der Elemente klicken, um die Details dieser Automatisierungsausführung aufzurufen.

    Details zur Automatisierungsausführung in der Google Cloud Console

Bereinigen

Mit den folgenden Schritten vermeiden Sie, dass Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen in Rechnung gestellt werden:

  1. GKE-Cluster oder Cloud Run löschen 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, Releases und Roll-outs:

    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 mit _clouddeploy und 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