Bereitstellungsparameter verwenden

Auf dieser Seite wird beschrieben, wie Sie mit Cloud Deploy eine Beispielanwendung gleichzeitig auf zwei Ziele bereitstellen (eine parallele Bereitstellung) und dabei mit drei verschiedenen Methoden einen anderen Parameterwert an jedes gerenderte Manifest oder jede Dienstdefinition übergeben.

Dieser Schnellstart erläutert folgende Schritte:

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

    Sie können auch angehängte GKE-Cluster verwenden. In dieser Kurzanleitung werden jedoch nur GKE und Cloud Run verwendet.

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

    Das Manifest oder die Dienstdefinition ist für beide untergeordneten Zielegleich. Bei der Bereitstellung haben das gerenderte Manifest oder die gerenderte Dienstdefinition für jedes untergeordnete Ziel unterschiedliche Werte für die in dieser Kurzanleitung konfigurierten Parameter.

  3. Definieren Sie Ihre Cloud Deploy-Bereitstellungspipeline und Bereitstellungsziele.

    Diese Pipeline hat ein Multi-Ziel, das auf zwei untergeordnete Ziele verweist, um Ihre Anwendung auf den beiden Clustern oder den beiden Diensten bereitzustellen.

  4. Definieren Sie Bereitstellungsparameter an drei verschiedenen Stellen:

    • Im Pipelinefortschritt
    • Auf den untergeordneten Zielen
    • In der Befehlszeile beim Erstellen des Release

  5. Instanziieren Sie Ihre Lieferpipeline. Dazu erstellen Sie einen Release, der automatisch parallel auf den beiden Zielen bereitgestellt wird.

  6. Sehen Sie sich den Controller-Roll-out und die untergeordneten Roll-outs in der Google Cloud Console an.

Hinweis

  1. Melden Sie sich in Ihrem Google Cloud -Konto an. Wenn Sie noch kein Google Cloud-Konto haben, 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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  5. Installieren Sie die Google Cloud CLI.

  6. Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  7. Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren: 

    gcloud init

  8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

  10. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  11. Installieren Sie die Google Cloud CLI.

  12. Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  13. Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren: 

    gcloud init

    14. Wenn Sie die CLI bereits installiert haben, prüfen Sie, ob Sie die neueste Version verwenden: 

    gcloud components update

  14. Achten Sie darauf, dass das Compute Engine-Standarddienstkonto die erforderlichen Berechtigungen hat.

    Das Dienstkonto hat möglicherweise bereits die erforderlichen Berechtigungen. Diese Schritte gelten für Projekte, 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)")-compute@developer.gserviceaccount.com \
    --role="roles/clouddeploy.jobRunner"

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

    3. Fügen Sie die Rolle iam.serviceAccountUser hinzu, die die Berechtigung actAs 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

Laufzeitumgebungen erstellen

Wenn Sie in Cloud Run bereitstellen, 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 erreichbar sein. Auf GKE-Cluster kann standardmäßig extern zugegriffen werden.

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 zu den bereitzustellenden Elementen und deren korrekte Bereitstellung für separate Ziele anzugeben.

In dieser Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, in der das Kubernetes-Manifest oder die Cloud Run-Dienstdefinition angegeben ist, die zum Bereitstellen der Beispielanwendung verwendet werden soll.

  1. Öffnen Sie ein Terminalfenster.

  2. Erstellen Sie ein neues Verzeichnis und wechseln Sie in dieses Verzeichnis.

    GKE 

    mkdir deploy-params-gke-quickstart
cd deploy-params-gke-quickstart

    Cloud Run 

    mkdir deploy-params-run-quickstart
cd deploy-params-run-quickstart

  3. 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. Für diese Kurzanleitung erstellen Sie die Datei. Sie können sie aber auch von Cloud Deploy für einfache Anwendungen erstellen lassen, die nicht für die Produktion bestimmt sind.

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

  4. 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 mit 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 Kubernetes Manifest, das auf den Cluster angewendet wird, um die Anwendung zu bereitstellen. Das bereitzustellende Container-Image wird hier als ein Platzhalter, my-app-image, festgelegt, der beim Erstellen des Release durch das spezifische Image ersetzt wird, wenn Sie das Release erstellen.

    Cloud Run

    Erstellen Sie eine Datei mit dem Namen service.yaml und mit 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 grundlegende Cloud Run-Dienstdefinition, die zum Bereitstellen der Anwendung verwendet wird. Das bereitzustellende Container-Image wird hier als Platzhalter my-app-imagefestgelegt, der beim Erstellen des Release durch das spezifische Image ersetzt wird.

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.

  1. Erstellen Sie die Definition für Ihre Lieferpipeline und Ihr Ziel:

    GKE

    Erstellen Sie im Verzeichnis deploy-params-gke-quickstart eine neue Datei mit dem Namen clouddeploy.yaml und 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"
      # Apply the deploy parameter replicaCount: "2" to the target with this label
      matchTargetLabels:
        label1: label1
    - values:
        replicaCount: "3"
      # Apply the deploy parameter replicaCount: "3" to the target with this label
      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 mit dem Namen clouddeploy.yaml und 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"
      # Apply the deploy parameter minInstances: "2" to the target with this label
      matchTargetLabels:
        label1: label1
    - values:
        minInstances: "3"
      # Apply the deploy parameter minInstances: "3" to the target with this label
      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

  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 zwei GKE- oder Cloud Run-Ziele umfasst, und können Ihre Anwendung bereitstellen.

  3. Bestätigen Sie Pipeline und Ziele:

    Rufen Sie in der Google Cloud Console die Google Cloud-Seite Lieferpipelines auf, um eine Liste der verfügbaren Liefer pipelines aufzurufen.

    Zur Seite der Lieferpipelines

    Die soeben erstellte Lieferpipeline wird angezeigt. In der Spalte Ziele ist nur ein Ziel aufgeführt, obwohl Sie in der Datei clouddeploy.yaml drei Ziele konfiguriert haben (ein Multi-Ziel und zwei untergeordnete Ziele).

    Visualisierung der Bereitstellungspipeline in der Google Cloud Console

    Das einzige aufgeführte Ziel ist das Multi-Ziel params-prod-multi. Untergeordnete Ziele werden nicht angezeigt.

Release erstellen

Ein Release ist die zentrale Cloud Deploy-Ressource, die die bereitzustellenden Änderungen darstellt. Die Lieferpipeline definiert den Lebenszyklus dieses Release. Weitere Informationen zu diesem Lebenszyklus finden Sie unter Cloud Deploy-Dienstarchitektur.

GKE

Führen Sie den folgenden Befehl im deploy-gke-parallel-quickstart -Verzeichnis 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"

Beachten Sie das --images= Flag, mit dem Sie den Platzhalter (my-app-image) im Manifest durch das spezifische, SHA-qualifizierte Image ersetzen. Google empfiehlt, Ihre Manifeste auf diese Weise zu templatieren und beim Erstellen des Release SHA-qualifizierte Image Namen zu verwenden.

Cloud Run

Führen Sie den folgenden Befehl im deploy-run-parallel-quickstart Verzeichnis 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:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a \
   --deploy-parameters="git-sha=f787cac"

Beachten Sie das --images= Flag, mit dem Sie den Platzhalter (my-app-image) in der Dienstdefinition durch das spezifische, SHA-qualifizierte Image ersetzen. Google empfiehlt, Ihre Dienst- und Jobdefinitionen auf diese Weise zu templatieren und beim Erstellen des Release SHA-qualifizierte Image-Namen zu verwenden.

Wie immer wird beim Erstellen eines Release automatisch ein Roll-out für das erste Ziel in Ihrer Pipeline erstellt (sofern kein bestimmtes Ziel mit --to-target= angegeben wird). In dieser Kurzanleitung ist dieses Ziel ein Multi-Ziel. Der rollout ist also ein Controller-Roll-out für zwei untergeordnete Ziele und es gibt keine nachfolgenden Ziele in der Lieferpipeline. Das bedeutet, dass Ihre Anwendung bei der Erstellung des Roll-out überall bereitgestellt wird.

Ergebnisse in der Google Cloud Console ansehen

Nachdem Sie den Release erstellt haben und der Controller-Roll-out und die untergeordneten Roll-outs erstellt wurden, werden diese untergeordneten Roll-outs jetzt in den jeweiligen GKE-Clustern oder Cloud Run-Diensten bereitgestellt (oder sind gerade in der Bereitstellung).

  1. Rufen Sie in der Google Cloud Console die Google Cloud-Seite Lieferpipelines auf, um Ihre Lieferpipeline my-parallel-demo-app-1 aufzurufen.

    Zur Seite der Lieferpipelines

  2. Klicken Sie auf den Namen der Lieferpipeline „my-parallel-demo-app-1“.

    Die Pipelinevisualisierung zeigt den Bereitstellungsstatus der Anwendung. Da die Pipeline nur eine Phase hat, wird in der Visualisierung nur ein Knoten angezeigt.

    Visualisierung der Lieferpipeline in der Google Cloud Console

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

  3. Klicken Sie auf den Releasenamen, test-release-001.

    Ihre Roll-outs werden unter Roll-outs angezeigt. Sie können auf einen Roll-out klicken, um die Details aufzurufen, einschließlich des Bereitstellungsprotokolls.

    Roll-outs in der Google Cloud Console

  4. Wählen Sie unter Releasedetails den Tab Artefakte aus.

    In der Tabelle Bereitstellungsparameter sind alle Parameter aufgeführt, die Sie im Manifest konfiguriert haben, sowie die Werte, die Sie für diese Parameter angegeben haben:

    GKE

    Bereitstellungsparameter und ‑werte in der Google Cloud Console

    Cloud Run

    Bereitstellungsparameter und ‑werte in der Google Cloud Console

    Neben den Parametern und Werten zeigt die Tabelle auch, auf welches Ziel jeder Parameter angewendet wird.

  5. Klicken Sie in der Spalte Release-Prüftool für eines der Ziele auf Artefakte ansehen.

  6. Klicken Sie auf Unterschied anzeigen und wählen Sie dann params-prod-a für ein Ziel und params-prod-b für das andere aus.

    Es wird ein Unterschied angezeigt, der die gerenderten Manifeste der beiden Ziele vergleicht, einschließlich der von Ihnen angegebenen Werte:

    GKE

    Differenz der gerenderten Manifeste mit übergebenen Werten

    Cloud Run

    Ein zielspezifisches gerendertes Manifest mit übergebenen Werten

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 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

  2. Löschen Sie die Lieferpipeline, 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

  3. Löschen Sie die von Cloud Deploy erstellten Cloud Storage-Buckets.

    Einer endet mit _clouddeploy und der andere ist [region].deploy-artifacts.[project].appspot.com.

    Die Cloud Storage-Browserseite öffnen

Das war alles. Sie haben diesen Schnellstart abgeschlossen!

Nächste Schritte