Hochstufung von Releases und Roll-out in Cloud Deploy automatisieren
Auf dieser Seite erfahren Sie, wie Sie mit Cloud Deploy einen Release automatisch zu einem Ziel hochstufen und ein Roll-out in die nächste Phase überführen.
Dieser Schnellstart erläutert folgende Schritte:
Zwei GKE-Cluster oder zwei Cloud Run-Dienste erstellen
Erstellen Sie eine Skaffold-Konfiguration und entweder ein Kubernetes-Manifest oder eine Cloud Run-Dienstdefinition.
Definieren Sie die Cloud Deploy-Bereitstellungspipeline und die Deployment-Ziele.
Die Pipeline wird für zwei Ziele bereitgestellt:
dev
undstaging
. Das Zielstaging
verwendet eine Canary-Bereitstellungsstrategie.Definieren Sie zwei Automatisierungsregeln:
Eine Automatisierung, mit der der Release bei erfolgreichem Roll-out in
dev
zum Zielstaging
hochgestuft wird.Eine Automatisierung, um das Roll-out nach erfolgreichem Abschluss der
canary-25
-Phase in diestable
-Phase überzugehen.
Instanziieren Sie die Bereitstellungspipeline. Erstellen Sie dazu einen Release, der automatisch im Ziel
dev
bereitgestellt wird.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 diecanary-25
-Phase übersprungen. Unter Gründe für das Überspringen von Phasen finden Sie weitere Informationen dazu, warum die Canary-Phase zum ersten Mal übersprungen wird.Aufgrund der automatisierten Fortsetzung der Phase geht das Roll-out in die
stable
-Phase über.
Hinweise
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.
-
Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs aktivieren.
- Installieren Sie die Google Cloud CLI.
-
Führen Sie folgenden Befehl aus, um die gcloud CLI zu initialisieren:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.
-
Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs aktivieren.
- Installieren Sie die Google Cloud CLI.
-
Führen Sie folgenden Befehl aus, um die gcloud CLI zu initialisieren:
gcloud init
- Prüfen Sie, ob das Compute Engine-Standarddienstkonto die erforderlichen Berechtigungen hat.
Das Dienstkonto hat möglicherweise bereits die erforderlichen Berechtigungen. Diese Schritte gelten für Projekte, bei denen automatische Rollenzuweisungen für Standarddienstkonten deaktiviert sind.
- 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"
- 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)")-compute@developer.gserviceaccount.com \ --role="roles/clouddeploy.releaser"
- 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"
-
Fügen Sie die Rolle
iam.serviceAccountUser
hinzu, die die BerechtigungactAs
für das Standarddienstkonto 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
-
Fügen Sie die Rolle
iam.serviceAccountUser
mit der BerechtigungactAs
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)")-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 zugreifen.
- Fügen Sie zuerst die Rolle
Wenn Sie die Befehlszeile bereits installiert haben, prüfen Sie, ob Sie die neueste Version verwenden:
gcloud components update
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 Standardeinstellungen. Die Kubernetes API-Endpunkte des Clusters müssen über das öffentliche Internet mit dem 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
Hol dir deine Projektnummer.
Sie benötigen Ihre Projektnummer, um das Standarddienstkonto zu identifizieren. Dies ist zum Konfigurieren der Automatisierungsressource erforderlich.
Führen Sie den folgenden Befehl aus, um Ihre Projektnummer abzurufen:
gcloud projects describe PROJECT_ID
Kopieren Sie die Projektnummer aus der Befehlszeilenausgabe und fügen Sie sie hier ein.
Sie müssen dies nicht als Befehl ausführen. Wenn Sie ihn hier einfügen, wird die Dienstkontoreferenz später in dieser Kurzanleitung in die Automatisierungskonfiguration eingefügt.
PROJECT_NUMBER
Skaffold-Konfiguration und Anwendungsmanifest vorbereiten
Cloud Deploy verwendet Skaffold, um Details dazu bereitzustellen, was bereitgestellt werden soll und wie es für Ihre separaten Ziele korrekt bereitgestellt wird.
In dieser Kurzanleitung erstellen Sie eine skaffold.yaml
-Datei, die das Anwendungsmanifest identifiziert, das zum Bereitstellen der Beispielanwendung verwendet werden soll.
Öffnen Sie ein Terminalfenster.
Erstellen Sie ein neues Verzeichnis und wechseln Sie zu diesem Verzeichnis.
GKE
mkdir deploy-automation-gke-quickstart cd deploy-automation-gke-quickstart
Cloud Run
mkdir deploy-automation-run-quickstart cd deploy-automation-run-quickstart
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 jedoch auch eine von Cloud Deploy erstellen lassen, und zwar für einfache Nicht-Produktionsanwendungen.
Weitere Informationen zu dieser Datei finden Sie in der Referenz zu
skaffold.yaml
.Erstellen Sie die Definition für Ihre Anwendung. Dazu sollten Sie zwei Dienstdefinitionen für Cloud Run oder ein Kubernetes-Manifest für GKE erstellen.
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
Bei dieser Datei handelt es sich um ein einfaches Kubernetes-Manifest, das auf den Cluster angewendet wird, um die Anwendung bereitzustellen.
Cloud Run
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
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 zum Erstellen Ihres Cloud Run-Dienstes verwendet wird.
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.
Erstellen Sie Ihre Bereitstellungspipeline, Zieldefinitionen und Automatisierungsaktionen:
GKE
Erstellen Sie im Verzeichnis
deploy-automation-gke-quickstart
eine neue Dateiclouddeploy.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 Dateiclouddeploy.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
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 zwei GKE- oder Cloud Run-Ziele umfasst, in denen Sie Ihre Anwendung bereitstellen können.
Bestätigen Sie Pipeline und Ziele:
Rufen Sie in der Google Cloud Console die Seite Bereitstellungspipelines von Cloud Deploy auf, um eine Liste der verfügbaren Bereitstellungspipelines aufzurufen.
Zur Seite der Lieferpipelines
Nun wird die Bereitstellungspipeline angezeigt, die Sie gerade erstellt haben. In der Spalte Ziele sind zwei Ziele aufgeführt.
Klicken Sie auf den Namen der Pipeline, um die Visualisierung und Details der Bereitstellungspipeline zu öffnen.
Wählen Sie unter Details zur Bereitstellungspipeline den Tab Automatisierungen aus.
Die beiden automatisierten Abläufe, die Sie erstellt haben, 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=us-docker.pkg.dev/cloudrun/container/hello@sha256:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc
Wenn Sie einen Release erstellen, wird standardmäßig automatisch ein Rollout für das erste Ziel in Ihrer Pipeline erstellt.
Da diese Kurzanleitung zwei Automatisierungen enthält, werden zwei Dinge automatisch ausgeführt:
Nach einer erfolgreichen Bereitstellung im ersten Ziel wird der Release automatisch zum zweiten Ziel hochgestuft.
Für die Automatisierung des Angebots gibt es eine Wartezeit von einer Minute.
Im zweiten Ziel, in dem ein Canary-Test von 25% konfiguriert ist, fährt die zweite Automatisierung das Rollout von
canary-25
aufstable
fort.In diesem ersten Release wird die Phase
canary-25
übersprungen, da es keine vorhandene Version der Anwendung für einen erneuten Canary-Test gibt. Das Roll-out wird automatisch aufstable
fortgesetzt.Bei der erweiterten Automatisierung kommt es zu einer Verzögerung von einer Minute.
Wenn der Vorgang abgeschlossen ist, wird die Anwendung erfolgreich für beide Ziele bereitgestellt, ohne dass Sie etwas tun müssen.
Weitere Informationen zur Ausführung einer Canary-Bereitstellungsstrategie finden Sie im Canary-Schnellstart.
Ergebnisse in der Google Cloud Console ansehen
Sie können die Ergebnisse, einschließlich der Automatisierungsausführungen, in der Google Cloud Console ansehen.
Rufen Sie in Cloud Deploy die Seite Bereitstellungspipelines auf, um Ihre Bereitstellungspipeline anzusehen.
Zur Seite der Lieferpipelines
Klicken Sie auf den Namen Ihrer Bereitstellungspipeline „my-automation-demo-app-1“.
Die Pipeline-Visualisierung zeigt den Bereitstellungsstatus der Anwendung. Wenn genug Zeit verstrichen ist, werden beide Ziele grün angezeigt.
Ihre Version wird auf dem Tab Releases unter Details zur Lieferpipeline aufgeführt.
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 Optionen klicken, um die Details dieser Automatisierungsausführung aufzurufen.
Bereinigen
Mit den folgenden Schritten vermeiden Sie, dass Ihrem Google Cloud-Konto die auf dieser Seite verwendeten Ressourcen in Rechnung gestellt werden.
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
Löschen Sie die Bereitstellungspipeline, Ziele, Automatisierungen, Releases und Roll-outs:
gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
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!