Bereitstellungsparameter verwenden

Auf dieser Seite erfahren Sie, wie Sie mit Cloud Deploy eine Beispielanwendung gleichzeitig an zwei Ziele bereitstellen (parallele Bereitstellung), wobei Sie jedem gerenderten Manifest oder jeder Dienstdefinition mithilfe von drei verschiedenen Methoden einen anderen Parameterwert übergeben.

Dieser Schnellstart erläutert folgende Schritte:

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

    Sie können auch GKE Enterprise-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 Ziele identisch. Beim Bereitstellen haben das gerenderte Manifest oder die gerenderte Dienstdefinition für jedes untergeordnete Ziel jedoch 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 App an die beiden Cluster oder Dienste zu liefern.

  4. Sie können Bereitstellungsparameter an drei verschiedenen Stellen definieren:

    • In der Pipeline
    • Auf die untergeordneten Ziele
    • In der Befehlszeile beim Erstellen des Release
  5. Instanziieren Sie Ihre Bereitstellungspipeline. Dazu erstellen Sie einen Release, der automatisch parallel auf die beiden Ziele bereitgestellt wird.

  6. Rufen Sie das „Controller-Roll-out“ und die untergeordneten Roll-outs in der Google Cloud Console auf.

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, prüfen Sie, ob Sie die neueste Version verwenden:

    gcloud components update
    

  13. Achten Sie darauf, dass das Compute Engine-Standarddienstkonto ausreichend 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 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"
        

    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 die Bereitstellung in Cloud Run ausführen, können Sie diesen Befehl überspringen.

Erstellen Sie für GKE zwei Cluster: deploy-params-cluster-prod1 und deploy-params-cluster-prod2 mit den 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 wird, die zum Bereitstellen der Beispielanwendung verwendet werden soll.

  1. Öffnen Sie ein Terminalfenster.

  2. 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
    
  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. In dieser Kurzanleitung erstellen Sie die Datei. Sie können aber auch Cloud Deploy bitten, eine für Sie zu erstellen, wenn es sich um einfache Anwendungen handelt, 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 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 bereitzustellen. Das bereitzustellende Container-Image wird hier als Platzhalter my-app-image festgelegt, der beim Erstellen der Version durch das entsprechende Image ersetzt wird.

    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 grundlegende Cloud Run-Dienstdefinition, die zum Bereitstellen der Anwendung verwendet wird. Das zu implementierende Container-Image wird hier als Platzhalter (my-app-image) festgelegt. Es wird durch das spezifische Image ersetzt, wenn Sie die Version erstellen.

Lieferpipeline und Ziele erstellen

Sie können Pipeline und Ziele in einer Datei oder in separaten Dateien definieren. In dieser Kurzanleitung erstellen wir nur eine Datei.

  1. Erstellen Sie die Bereitstellungspipeline und die Zieldefinition:

    GKE

    Erstellen Sie im Verzeichnis deploy-params-gke-quickstart die 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"
          # 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 die 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"
          # 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 Mehrfachziel, das aus zwei GKE- oder Cloud Run-Zielen besteht, und können Ihre Anwendung bereitstellen.

  3. Bestätigen Sie Pipeline und Ziele:

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

    Zur Seite der Lieferpipelines

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

    Lieferpipeline-Visualisierung 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 bereitgestellten Änderungen darstellt. Die Bereitstellungspipeline definiert den Lebenszyklus dieser Version. Weitere Informationen zu diesem Lebenszyklus finden Sie unter Cloud Deploy-Dienstarchitektur.

GKE

Führen Sie folgenden Befehl im Verzeichnis deploy-gke-parallel-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-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 modellieren und beim Erstellen von Releases SHA-qualifizierte Image-Namen zu verwenden.

Cloud Run

Führen Sie folgenden Befehl im Verzeichnis deploy-run-parallel-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-params-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4 \
   --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 modellieren und beim Erstellen von Releases SHA-qualifizierte Image-Namen zu verwenden.

Wie immer wird beim Erstellen eines Releases automatisch ein Roll-out für das erste Ziel in Ihrer Pipeline erstellt, es sei denn, mit --to-target= wird ein bestimmtes Ziel angegeben. In dieser Schnellstartanleitung ist dieses Ziel ein Mehrfachziel. rollout ist also ein „Controller-Roll-out“ für zwei untergeordnete Ziele und es gibt keine nachfolgenden Ziele in der Bereitstellungspipeline. Das bedeutet, dass Ihre Anwendung beim Erstellen des Roll-outs überall bereitgestellt wird.

Ergebnisse in der Google Cloud Console ansehen

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

  1. Rufen Sie in der Google Cloud Console die Cloud Deploy-Seite Bereitstellungspipelines auf, um die Bereitstellungspipeline 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 App. Da es nur eine Phase in der Pipeline gibt, wird in der Visualisierung nur ein Knoten angezeigt.

    Lieferpipeline-Visualisierung 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 Einführungen werden unter Einführungen angezeigt. Sie können auf ein Roll-out klicken, um die Details aufzurufen, einschließlich des Bereitstellungslogs.

    Roll-outs in der Google Cloud Console

  4. Wählen Sie unter Release-Details den Tab Artefakte aus.

    In der Tabelle Deployment-Parameter sind alle Parameter aufgeführt, die Sie in Ihrem Manifest konfiguriert haben, sowie die von Ihnen angegebenen Werte für diese Parameter:

    GKE

    Bereitstellungsparameter und ‑werte, die in der Google Cloud Console angezeigt werden

    Cloud Run

    Bereitstellungsparameter und ‑werte, die in der Google Cloud Console angezeigt werden

    Neben den Parametern und Werten sehen Sie in der Tabelle auch, auf welches Ziel sich die einzelnen Parameter beziehen.

  5. Klicken Sie in der Spalte Release-Inspector für jedes Ziel auf Artefakte ansehen.

  6. Klicken Sie auf Vergleich anzeigen und wählen Sie dann params-prod-a für das erste Ziel und params-prod-b für das zweite aus.

    Es wird eine Differenz angezeigt, in der die gerenderten Manifeste der beiden Ziele verglichen werden, 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 in dieser Anleitung 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. So löschen Sie die Bereitstellungspipeline, das Multi-Ziel, untergeordnete Ziele, den Release und die Einführungen:

    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