Bereitstellungsparameter verwenden
Auf dieser Seite erfahren Sie, wie Sie mit Cloud Deploy eine Beispielanwendung für zwei Ziele gleichzeitig bereitstellen (parallele Bereitstellung) und mithilfe von drei verschiedenen Methoden einen anderen Parameterwert an jedes gerenderte Manifest oder jede Dienstdefinition übergeben.
Dieser Schnellstart erläutert folgende Schritte:
Zwei GKE-Cluster oder zwei Cloud Run-Dienste erstellen.
Sie können auch GKE Enterprise-Cluster verwenden. In dieser Kurzanleitung werden jedoch nur GKE und Cloud Run verwendet.
Erstellen Sie eine Skaffold-Konfiguration und entweder ein Kubernetes-Manifest oder eine Cloud Run-Dienstdefinition.
Das Manifest oder die Dienstdefinition ist für beide untergeordnete Ziele identisch, aber zum Zeitpunkt der Bereitstellung hat das gerenderte Manifest oder die Dienstdefinition für jedes untergeordnete Ziel unterschiedliche Werte für die in dieser Kurzanleitung konfigurierten Parameter.
Definieren Sie Ihre Bereitstellungspipeline und Bereitstellungsziele für Cloud Deploy.
Diese Pipeline hat ein multi-target, das auf zwei untergeordnete Ziele verweist, um Ihre Anwendung an die zwei Cluster oder zwei Dienste bereitzustellen.
Definieren Sie Bereitstellungsparameter an drei verschiedenen Stellen:
- Fortschritt in der Pipeline
- Auf die untergeordneten Ziele
- In der Befehlszeile beim Erstellen des Release
Instanziieren Sie Ihre Bereitstellungspipeline. Erstellen Sie dazu einen Release, der automatisch parallel auf den beiden Zielen bereitgestellt wird.
Sehen Sie sich das „Controller-Roll-out“ und die untergeordneten Roll-outs in der Google Cloud Console an.
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 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
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 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: deploy-params-cluster-prod1
und deploy-params-cluster-prod2
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 deploy-params-cluster-prod1 \
--project=PROJECT_ID \
--region=us-central1 \
&& gcloud container clusters create-auto deploy-params-cluster-prod2 \
--project=PROJECT_ID \
--region=us-west1
Skaffold-Konfiguration und Manifeste 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 Kubernetes-Manifest oder die Cloud Run-Dienstdefinition angibt, die zum Bereitstellen der Beispielanwendung verwendet werden soll.
Öffnen Sie ein Terminalfenster.
Erstellen Sie ein neues Verzeichnis und rufen Sie es auf.
GKE
mkdir deploy-params-gke-quickstart cd deploy-params-gke-quickstart
Cloud Run
mkdir deploy-params-run-quickstart cd deploy-params-run-quickstart
Erstellen Sie eine Datei mit dem Namen
skaffold.yaml
und mit folgendem Inhalt:GKE
apiVersion: skaffold/v4beta7 kind: Config manifests: rawYaml: - kubernetes.yaml deploy: kubectl: {}
Cloud Run
apiVersion: skaffold/v4beta7 kind: Config manifests: rawYaml: - service.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: eine Dienstdefinition für Cloud Run oder ein Kubernetes-Manifest für GKE.
GKE
Erstellen Sie eine Datei mit dem Namen
kubernetes.yaml
und folgendem Inhalt:apiVersion: apps/v1 kind: Deployment metadata: name: my-deployment spec: replicas: 1 # from-param: ${replicaCount} selector: matchLabels: app: my-app template: metadata: labels: app: my-app annotations: commit: defaultShaValue # from-param: ${git-sha} spec: containers: - name: nginx image: my-app-image env: - name: envvar1 value: default1 # from-param: ${application_env1} - name: envvar2 value: default2 # from-param: ${application_env2}
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-parallel-run-service spec: autoscaling.knative.dev/minScale: 1 # from-param: ${minInstances} selector: matchLabels: app: my-app template: metadata: annotations: commit: defaultShaValue # from-param: ${git-sha} spec: containers: - image: my-app-image env: - name: envvar1 value: defaultValue1 # from-param: ${application_env1} - name: envvar2 value: defaultValue2 # from-param: ${application_env2}
Diese Datei ist eine einfache Cloud Run-Dienstdefinition, die zum Zeitpunkt der Bereitstellung verwendet wird, um Ihren Cloud Run-Dienst zu erstellen.
Lieferpipeline und Ziele erstellen
Sie können Pipeline und Ziele in einer Datei oder in separaten Dateien definieren. In dieser Kurzanleitung erstellen wir eine einzelne Datei.
Erstellen Sie die Bereitstellungspipeline und die Zieldefinition:
GKE
Erstellen Sie im Verzeichnis
deploy-params-gke-quickstart
eine neue Datei:clouddeploy.yaml
mit folgendem Inhalt:apiVersion: deploy.cloud.google.com/v1 kind: DeliveryPipeline metadata: name: my-params-demo-app-1 description: main application pipeline serialPipeline: stages: - targetId: params-prod-multi deployParameters: - values: replicaCount: "2" matchTargetLabels: label1: label1 - values: replicaCount: "3" matchTargetLabels: label2: label2 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-multi description: production clusters multiTarget: targetIds: [params-prod-a, params-prod-b] --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-a labels: label1: label1 description: production cluster 1 deployParameters: application_env1: "sampleValue1" gke: cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-params-cluster-prod1 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-b labels: label2: label2 description: production cluster 2 deployParameters: application_env2: "sampleValue2" gke: cluster: projects/PROJECT_ID/locations/us-west1/clusters/deploy-params-cluster-prod2
Cloud Run
Erstellen Sie im Verzeichnis
deploy-params-run-quickstart
eine neue Datei:clouddeploy.yaml
mit folgendem Inhalt:apiVersion: deploy.cloud.google.com/v1 kind: DeliveryPipeline metadata: name: my-params-demo-app-1 description: main application pipeline serialPipeline: stages: - targetId: params-prod-multi deployParameters: - values: minInstances: "2" matchTargetLabels: label1: label1 - values: minInstances: "3" matchTargetLabels: label2: label2 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-multi description: production clusters multiTarget: targetIds: [params-prod-a, params-prod-b] --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-a labels: label1: label1 description: production cluster 1 deployParameters: application_env1: "sampleValue1" run: location: projects/PROJECT_ID/locations/us-central1 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-b labels: label2: label2 description: production cluster 2 deployParameters: application_env2: "sampleValue2" run: location: projects/PROJECT_ID/locations/us-west1
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
Die Bereitstellungspipeline, die Sie gerade erstellt haben, wird angezeigt. In der Spalte Ziele ist ein Ziel aufgeführt, obwohl Sie in der Datei
clouddeploy.yaml
drei Ziele (ein Multi-Ziel und zwei untergeordnete Ziele) konfiguriert haben.Beachten Sie, dass als einziges Ziel das Multi-Ziel
params-prod-multi
aufgeführt ist. Untergeordnete Ziele werden nicht 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 im Verzeichnis deploy-gke-parallel-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-params-demo-app-1 \
--images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa \
--deploy-parameters="git-sha=f787cac"
Cloud Run
Führen Sie im Verzeichnis deploy-run-parallel-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-params-demo-app-1 \
--images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc \
--deploy-parameters="git-sha=f787cac"
Wenn Sie einen Release erstellen, wird beim Erstellen eines Release automatisch ein Roll-out für das erste Ziel in Ihrer Pipeline (oder wie in diesem Fall ein mit --to-target=
angegebenes bestimmtes Ziel) erstellt. In dieser Kurzanleitung ist dieses Ziel ein Multi-Ziel, sodass rollout
ein „Controller-Roll-out“ für zwei untergeordnete Ziele ist und es keine nachfolgenden Ziele in der Bereitstellungspipeline gibt.
Das bedeutet, dass Ihre Anwendung bei der Roll-out-Erstellung überall bereitgestellt wird.
Ergebnisse in der Google Cloud Console ansehen
Nachdem Sie den Release erstellt haben und die Controller-Roll-outs und die untergeordneten Rollouts erstellt wurden, werden diese untergeordneten Roll-outs nun in den jeweiligen GKE-Clustern oder Cloud Run-Diensten bereitgestellt (oder werden gerade bereitgestellt).
Rufen Sie in der Google Cloud Console die Cloud Deploy-Seite Bereitstellungspipelines auf, um Ihre my-parallel-demo-app-1-Bereitstellungspipeline anzusehen.
Zur Seite der Lieferpipelines
Klicken Sie auf den Namen der Bereitstellungspipeline „my-parallel-demo-app-1“.
Die Pipelinevisualisierung zeigt den Bereitstellungsstatus der Anwendung. Da es in der Pipeline nur eine Phase gibt, zeigt die Visualisierung nur einen Knoten.
Ihre Version wird auf dem Tab Releases unter Details zur Lieferpipeline aufgeführt.
Klicken Sie auf den Releasenamen,
test-release-001
.Ihre Roll-outs werden unter Roll-outs angezeigt. Sie können auf ein Roll-out klicken, um die zugehörigen Details anzusehen, einschließlich des Bereitstellungslogs.
Wählen Sie unter Release-Details den Tab Artefakte aus.
Die Tabelle Deploy Parameters (Parameter bereitstellen) enthält alle Parameter, die Sie in Ihrem Manifest konfiguriert haben, sowie die Werte, die Sie für diese Parameter angegeben haben:
GKE
Cloud Run
Zusätzlich zu den Parametern und Werten zeigt die Tabelle, für welches Ziel die einzelnen Parameter gelten.
Klicken Sie in der Spalte Release-Inspector für eines der Ziele auf Artefakte ansehen.
Klicken Sie auf Unterschied einblenden und wählen Sie für ein Ziel
params-prod-a
und für das andere Zielparams-prod-b
aus.Es wird ein Unterschied angezeigt, bei dem die gerenderten Manifeste der beiden Ziele einschließlich der von Ihnen angegebenen Werte verglichen werden:
GKE
Cloud Run
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 deploy-params-cluster-prod1 --region=us-central1 --project=PROJECT_ID \ && gcloud container clusters delete deploy-params-cluster-prod2 --region=us-west1 --project=PROJECT_ID
Cloud Run
gcloud run services delete my-parallel-run-service --region=us-central1 --project=PROJECT_ID \ && gcloud run services delete my-parallel-run-service --region=us-west1 --project=PROJECT_ID
Löschen Sie die Bereitstellungspipeline, das Multi-Ziel, die untergeordneten Ziele, den Release und die 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!