Release-Hochstufung und Fortsetzung des Roll-outs 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 der nächsten Phase fortsetzen.
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 Ihre Bereitstellungspipeline und Bereitstellungsziele für Cloud Deploy.
Die Pipeline wird für zwei Ziele bereitgestellt:
dev
undstaging
. Und das Zielstaging
verwendet eine Canary-Bereitstellungsstrategie.Zwei Automatisierungsregeln definieren:
Eine Automatisierung, um den Release bei einem erfolgreichen Roll-out auf
dev
zum Zielstaging
hochzustufen.Eine Automatisierung, um das Roll-out nach erfolgreichem Abschluss der
canary-25
-Phase in diestable
-Phase fortzusetzen.
Instanziieren Sie Ihre 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 die Phasecanary-25
übersprungen. Unter Warum Phasen manchmal übersprungen werden erfahren Sie, warum die Canary-Phase beim ersten Mal übersprungen wird.Aufgrund des automatisierten Phasenfortschritts 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.
-
Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.
-
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
-
Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.
-
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 sind für Projekte enthalten, bei denen automatische Rollenzuweisungen für Standarddienstkonten deaktiviert werden.
- 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 zur Bereitstellung 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
hinzu, einschließlich der BerechtigungactAs
für sich selbst, 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 es sich um die neueste Version handelt:
gcloud components update
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 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 diesen Befehl nicht als Befehl ausführen. Wenn Sie ihn hier einfügen, wird später in dieser Kurzanleitung die Dienstkontoreferenz in der Automatisierungskonfiguration ausgefüllt.
PROJECT_NUMBER
Skaffold-Konfiguration und Anwendungsmanifest vorbereiten
Cloud Deploy verwendet Skaffold, um Details zur Bereitstellung und zur ordnungsgemäßen 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.
Öffnen Sie ein Terminalfenster.
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
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. In dieser Kurzanleitung erstellen Sie die Datei. Sie können aber auch eine Liste von Cloud Deploy für einfache Anwendungen erstellen lassen, die nicht in der Produktion verwendet werden.
Weitere Informationen zu dieser Datei finden Sie in der Referenz zu
skaffold.yaml
.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 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 zum Zeitpunkt 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.
Erstellen Sie Ihre Bereitstellungspipeline, Zieldefinitionen und eine 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: 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
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 Pipeline mit einem Multi-Ziel, das zwei GKE- oder Cloud Run-Ziele umfasst und bereit für die Bereitstellung Ihrer Anwendung ist.
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
Es wird die gerade erstellte Bereitstellungspipeline angezeigt. In der Spalte Ziele sind zwei Ziele aufgeführt.
Klicken Sie auf den Namen der Pipeline, um die Visualisierung und die Details der Bereitstellungspipeline zu öffnen.
Wählen Sie unter Details zur Bereitstellungspipeline den Tab Automatisierungen aus.
Nun werden die beiden automatisierten Abläufe angezeigt, die Sie erstellt haben.
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-automation-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=my-automation-demo-app-1 \
--images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa
Cloud Run
Führen Sie im Verzeichnis deploy-automation-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=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 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 Anzeigenauslieferung gilt eine Wartezeit von einer Minute.
Im zweiten Ziel, für das eine Canary-Version von 25% konfiguriert ist, setzt die zweite Automatisierung das Roll-out von
canary-25
aufstable
fort.Bei diesem ersten Release wird die Phase
canary-25
übersprungen, da es keine vorherige Version der Anwendung für eine erneute Canary-Version gibt. Das Roll-out wird automatisch aufstable
übertragen.Der Vorgang ist um eine Minute verzögert.
Wenn alles abgeschlossen ist, wird die Anwendung erfolgreich für beide Ziele bereitgestellt, ohne dass Sie weitere Maßnahmen ergreifen müssen.
Wenn Sie mehr über das Ausführen einer Canary-Bereitstellungsstrategie erfahren möchten, sehen Sie sich die Canary-Kurzanleitung an.
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 die Cloud Deploy-Seite Bereitstellungspipelines auf, um Ihre Bereitstellungspipeline anzusehen.
Zur Seite der Lieferpipelines
Klicken Sie auf den Namen der Bereitstellungspipeline „my-automation-demo-app-1“.
Die Pipelinevisualisierung 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 von Ihnen erstellten Automatisierungen. Sie können auf einen der beiden Typen klicken, um die Details der entsprechenden 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, Release und Roll-outs:
gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
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!