Roll-outs mit einer Bereitstellungsrichtlinie einschränken

Roll-outs mit einer Bereitstellungsrichtlinie einschränken

Vorschau

Dieses Produkt oder diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Produkte und -Funktionen sind unverändert verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

In dieser Kurzanleitung erfahren Sie, wie Sie Cloud Deploy-Roll-outs auf ein Ziel innerhalb eines bestimmten Zeitraums verhindern und diese Einschränkung überschreiben.

Dieser Schnellstart erläutert folgende Schritte:

1. Erstellen Sie eine Skaffold-Konfiguration und ein Kubernetes-Manifest oder eine Cloud Run-Dienstdefinition, um das (vordefinierte) Container-Image anzugeben.

2. Definieren Sie Ihre Cloud Deploy-Lieferpipeline und ein Bereitstellungsziel, das auf einen GKE-Cluster oder einen Cloud Run-Dienst verweist.

   Diese Pipeline enthält nur eine Phase für das eine Ziel.

3. Konfigurieren Sie eine Bereitstellungsrichtlinie für ein Ziel.

   Die Richtlinie definiert einen Zeitraum, in dem keine Einführungen für dieses Ziel erfolgen dürfen.

4. Erstellen Sie einen Release.

   Normalerweise erstellt Cloud Deploy beim Erstellen eines Releases ein Roll-out für das erste Ziel in Ihrer Bereitstellungspipeline. In diesem Fall wird das Roll-out für das Ziel nicht erstellt, da eine Richtlinie die Bereitstellung am Ziel verhindert.

5. Rufen Sie die Ergebnisse in der Google Cloud Console auf.

   Aufgrund der Richtlinie wird kein Roll-out für die Version angezeigt und in der Visualisierung der Bereitstellungspipeline gibt es keine ausstehende Aktion.

6. Überschreiben Sie die Bereitstellungsrichtlinie.

   Durch diese Überschreibung wird das Roll-out jetzt von Cloud Deploy für das Ziel erstellt.

7. Rufen Sie die Ergebnisse in der Google Cloud Console auf.

   Da die Richtlinie jetzt überschrieben wurde, sehen Sie, dass ein Roll-out in Bearbeitung ist (oder abgeschlossen wurde, wenn genügend Zeit vergangen ist).

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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, 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

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

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

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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, 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

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

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

gcloud components update

12. 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)")[e-mail] \
       --role="roles/clouddeploy.jobRunner"
   

2. Die clouddeploy.policyAdmin-Rolle hinzufügen:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/clouddeploy.policyAdmin"
   

3. 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)")[e-mail] \
      --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)")[e-mail] \
      --role="roles/run.developer"
  

4. 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)")[e-mail] \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/iam.serviceAccountUser" \
       --project=PROJECT_ID
   

Laufzeitumgebung erstellen

Wenn Sie die Bereitstellung in Cloud Run ausführen, können Sie diesen Befehl überspringen.

Erstellen Sie für GKE einen Cluster: quickstart-cluster-qsprod. Der Kubernetes API-Endpunkt des Clusters muss über das Netzwerk vom öffentlichen Internet aus erreichbar sein. GKE-Cluster sind standardmäßig extern zugänglich.

gcloud container clusters create-auto quickstart-cluster-qsprod \
                 --project=PROJECT_ID \
                 --region=us-central1

Skaffold-Konfiguration und Anwendungsmanifest vorbereiten

Cloud Deploy verwendet Skaffold, um Details zu den bereitzustellenden Elementen und deren korrekte Bereitstellung für Ihr Ziel anzugeben.

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

1. Öffnen Sie ein Terminalfenster.

2. Erstellen Sie ein neues Verzeichnis und rufen Sie es auf.

   mkdir deploy-policy-quickstart
   cd deploy-policy-quickstart
   

3. Erstellen Sie eine Datei mit dem Namen skaffold.yaml und mit folgendem Inhalt:

   GKE

   apiVersion: skaffold/v4beta1
   kind: Config
   manifests:
     rawYaml:
     - k8s-pod.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta1
   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 sich aber auch eine von Cloud Deploy erstellen lassen, wenn es sich um einfache, nicht für die Produktion bestimmte Anwendungen handelt.

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

4. Erstellen Sie das Manifest 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 k8s-pod.yaml und folgendem Inhalt:

   apiVersion: v1
   kind: Pod
   metadata:
     name: getting-started
   spec:
     containers:
     - name: nginx
       image: my-app-image
   

   Diese Datei ist ein einfaches 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-deploy-policy-run-service
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

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

Sie können die Lieferpipeline und die Ziele in einer Datei oder in separaten Dateien definieren. In dieser Kurzanleitung erstellen Sie eine einzelne Datei mit beiden.

1. Erstellen Sie die Bereitstellungspipeline und die Zieldefinition:

   GKE

   Erstellen Sie im Verzeichnis deploy-policy-quickstart die neue Datei clouddeploy.yaml mit folgendem Inhalt:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-policy-pipeline
   serialPipeline:
     stages:
     - targetId: prod-target
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: prod-target
   description: production cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/quickstart-cluster-qsprod
   

   Cloud Run

   Erstellen Sie im Verzeichnis deploy-policy-quickstart die neue Datei clouddeploy.yaml mit folgendem Inhalt:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-policy-pipeline
   serialPipeline:
     stages:
     - targetId: prod-target
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: prod-target
   description: production Run service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   Hinweis: In dieser Datei ist das Ziel in der Lieferpipeline enthalten. Sie können Ziele auch in einer separaten Datei oder mehreren separaten Dateien definieren.

2. Registrieren Sie Ihre Pipeline und Zielressourcen beim Cloud Deploy-Dienst:

   gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
   

   Sie haben jetzt eine Bereitstellungspipeline mit einem Ziel.

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 Bereitstellungspipeline wird angezeigt. In der Spalte Ziele ist ein Ziel aufgeführt.

   

Bereitstellungsrichtlinie erstellen

Sie können die Bereitstellungsrichtlinie in derselben Datei wie die Lieferpipeline und die Ziele oder in einer separaten Datei definieren. In dieser Kurzanleitung definieren wir sie separat.

1. Erstellen Sie im selben Verzeichnis, in dem Sie die Bereitstellungspipeline und die Ziele erstellt haben, eine neue Datei namens deploypolicy.yaml mit folgendem Inhalt:

   apiVersion: deploy.cloud.google.com/v1
   description: Restrict all rollouts in the deploy-policy-pipeline resource for the next ten years
   kind: DeployPolicy
   metadata:
     name: quickstart-deploy-policy
   selectors:
   - deliveryPipeline:
       id: 'deploy-policy-pipeline'
   rules:
   - rolloutRestriction:
       id: no-rollouts
       timeWindows:
         timeZone: America/New_York
         oneTimeWindows:
         - start: 2024-01-01 00:00
           end: 2034-01-01 24:00
   

   Diese Richtlinie blockiert Roll-outs ab dem 1. Januar 2024 für 10 Jahre. Diese Richtlinie ist nicht realistisch. Sie wird nur für diesen Schnellstart verwendet, damit die Richtlinie beim Erstellen der Version vorhanden ist.

2. Registrieren Sie die Bereitstellungsrichtlinienressource beim Cloud Deploy-Dienst:

   gcloud deploy apply --file=deploypolicy.yaml --region=us-central1 --project=PROJECT_ID
   

3. Bestätigen Sie die Bereitstellungsrichtlinie:

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

   Seite „Richtlinien für die Bereitstellung“ öffnen

   Die gerade erstellte Bereitstellungsrichtlinie wird 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 den folgenden Befehl im Verzeichnis deploy-policy-quickstart aus, um den Release zu erstellen:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-policy-pipeline \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Beachten Sie das --images=-Flag. Damit ersetzen Sie den Platzhalter (my-app-image) im Manifest oder in der Dienstdefinition durch das spezifische, SHA-qualifizierte Bild. 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 den folgenden Befehl im Verzeichnis deploy-policy-quickstart aus, um den Release zu erstellen:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-policy-pipeline \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

Beachten Sie das --images=-Flag, mit dem Sie den Platzhalter (my-app-image) im Manifest oder in der Dienstdefinition durch das spezifische, SHA-qualifizierte Bild ersetzen. Google empfiehlt, Ihre Manifeste auf diese Weise zu modellieren und beim Erstellen von Releases SHA-qualifizierte Image-Namen zu verwenden.

Normalerweise erstellt Cloud Deploy das Rollout für das erste Ziel, wenn Sie den Release mit diesem Befehl erstellen. Da Roll-outs gemäß der Bereitstellungsrichtlinie eingeschränkt sind, wird in diesem Fall kein Roll-out erstellt. In der Befehlszeile wird eine Fehlermeldung angezeigt:

ERROR: (gcloud.deploy.releases.create) A create-rollout attempt was blocked by the "quickstart-deploy-policy" policy. Target: "prod-target", Delivery pipeline: "deploy-policy-pipeline", policy rule: "no-rollouts"

Richtlinieneinschränkung überschreiben

Wenn Sie die Beispielanwendung bereitstellen möchten, die durch die Bereitstellungsrichtlinie blockiert wird, müssen Sie diese Richtlinie überschreiben. Dazu erstellen Sie ein neues Roll-out für diese Version, diesmal mit der Option --override-deploy-policies:

GKE

Führen Sie den folgenden Befehl im Verzeichnis deploy-policy-quickstart aus, um den Release zu erstellen:

 gcloud deploy releases promote --release=test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-policy-pipeline \
   --to-target=prod-target \
   --override-deploy-policies=quickstart-deploy-policy

Cloud Run

Führen Sie den folgenden Befehl im Verzeichnis deploy-policy-quickstart aus, um den Release zu erstellen:

 gcloud deploy releases promote --release=test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-policy-pipeline \
   --to-target=prod-target \
   --override-deploy-policies=quickstart-deploy-policy

Da Sie --override-deploy-policies=quickstart-deploy-policy angegeben haben und die Rolle roles/clouddeploy.policyAdmin haben, ignoriert Cloud Deploy die von Ihnen erstellte Bereitstellungsrichtlinie und führt die Bereitstellung auf der prod-target durch.

Ergebnisse in der Google Cloud Console ansehen

1. Rufen Sie in der Google Cloud Console noch einmal die Seite Lieferpipelines von Cloud Deploy auf, um Ihre Bereitstellungspipeline aufzurufen (deploy-policy-pipeline).

   Zur Seite der Lieferpipelines

2. Klicken Sie auf den Namen Ihrer Bereitstellungspipeline (deploy-policy-pipeline).

   Die Pipelinevisualisierung zeigt den Bereitstellungsstatus der App. In diesem Fall wurde das Roll-out erstellt und war erfolgreich, da die Richtlinie überschrieben wurde.

   

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

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 den GKE-Cluster oder Cloud Run-Dienst:

   GKE

   gcloud container clusters delete quickstart-cluster-qsprod --region=us-central1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-deploy-policy-run-service --region=us-central1 --project=PROJECT_ID
   

2. So löschen Sie die Bereitstellungsrichtlinie:

   gcloud deploy delete --file=deploypolicy.yaml --region=us-central1 --project=PROJECT_ID
   

3. So löschen Sie die Bereitstellungspipeline, das Ziel, den Release und das Roll-out:

   gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
   

4. Löschen Sie beide Cloud Storage-Buckets, die von Cloud Deploy erstellt wurden.

   Die Cloud Storage-Browserseite öffnen

Das war alles. Sie haben diesen Schnellstart abgeschlossen!

Nächste Schritte

• Weitere Informationen zu Cloud Deploy

• Grundlagen zum Bereitstellen von Anwendungen

• Informationen zum Kombinieren von Google Cloud-CI/CD-Tools, um Software effektiv für GKE zu entwickeln und bereitzustellen