Bereitstellungsrichtlinie zum Einschränken von Rollouts verwenden

Bereitstellungsrichtlinie zum Einschränken von Rollouts verwenden

In dieser Kurzanleitung erfahren Sie, wie Sie Cloud Deploy-Rollouts zu einem Ziel während 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 Bereitstellungs ziel, 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 Rollouts zu diesem Ziel untersagt sind.

4. Release erstellen

   Wenn Sie normalerweise einen Release erstellen, erstellt Cloud Deploy einen Rollout für das erste Ziel im Fortschritt Ihrer Lieferpipeline. Da in diesem Fall eine Richtlinie vorhanden ist, die die Bereitstellung für das Ziel verhindert, wird der Rollout für dieses Ziel nicht erstellt.

5. Sehen Sie sich die Ergebnisse in der Google Cloud Console an.

   Aufgrund der Richtlinie wird kein Rollout für den Release angezeigt und in der Visualisierung der Lieferpipeline ist keine ausstehende Aktion vorhanden.

6. Überschreiben Sie die Bereitstellungsrichtlinie.

   Diese Überschreibung führt dazu, dass Cloud Deploy jetzt den Rollout für das Ziel erstellt.

7. Sehen Sie sich die Ergebnisse in der Google Cloud Console an.

   Da die Richtlinie jetzt überschrieben wurde, sehen Sie, dass ein Rollout ausgeführt wird (oder abgeschlossen ist, wenn genügend Zeit vergangen ist).

Hinweis

Melden Sie sich in Ihrem Google Cloud -Konto an. Wenn Sie noch kein Google Cloud-Konto haben, erstellen Sie ein Konto, um zu sehen, wie sich unsere Produkte in realen Szenarien schlagen. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.
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.
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
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud Deploy, Cloud Build, GKE, 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
Installieren Sie die Google Cloud CLI.
Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.
Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:
gcloud init
Hinweis: Sie können die gcloud CLI in der Google Cloud Console ausführen, ohne die Google Cloud CLI zu installieren. Wenn Sie die gcloud CLI in der Google Cloud Console ausführen möchten, verwenden Sie Cloud Shell.

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.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, GKE, 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

Installieren Sie die Google Cloud CLI.

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

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

gcloud init

Hinweis: Sie können die gcloud CLI in der Google Cloud Console ausführen, ohne die Google Cloud CLI zu installieren. Wenn Sie die gcloud CLI in der Google Cloud Console ausführen möchten, verwenden Sie Cloud Shell.

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

gcloud components update

1. Prüfen Sie, ob das Standard Compute Engine-Dienstkonto 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)")[e-mail] \
       --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)")[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"
  

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)")[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 in Cloud Run bereitstellen, 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 öffentliche Internet erreichbar sein. Auf GKE-Cluster kann standardmäßig extern zugegriffen werden.

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 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 wechseln Sie zu diesem.

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

   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 mit 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 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-deploy-policy-run-service
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   Diese Datei ist eine einfache 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 Ziel erstellen

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

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

   GKE

   Erstellen Sie im Verzeichnis deploy-policy-quickstart eine 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 eine 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 Lieferpipeline mit einem Ziel.

3. Bestätigen Sie Pipeline und Ziele:

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

   Zur Seite der Lieferpipelines

   Die soeben erstellte Lieferpipeline wird angezeigt und ein Ziel wird in der Spalte Ziele aufgeführt.

   

Bereitstellungsrichtlinie erstellen

Sie können die Bereitstellungsrichtlinie in derselben Datei wie Ihre Lieferpipeline und Ihre Ziele definieren oder in einer separaten Datei. Für diese Kurzanleitung definieren wir sie separat.

1. Erstellen Sie im selben Verzeichnis, in dem Sie die Lieferpipeline und die Ziele erstellt haben, eine neue Datei 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 Rollouts für 10 Jahre ab dem 1. Januar 2024. Dies ist keine realistische Richtlinie. Sie wird nur für diese Kurzanleitung so erstellt, um sicherzustellen, dass die Richtlinie vorhanden ist, wenn Sie Ihren Release erstellen.

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

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

3. Bestätigen Sie Ihre Bereitstellungsrichtlinie:

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

   Seite „Bereitstellungsrichtlinien“ aufrufen

   Die soeben erstellte Bereitstellungsrichtlinie wird 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 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, mit dem Sie den Platzhalter (my-app-image) in der Manifest- oder Dienstdefinition durch das spezifische, SHA-qualifizierte Image ersetzen. Google empfiehlt, Ihre Manifeste auf diese Weise zu templatieren und bei der Erstellung des Release SHA-qualifizierte Imagenamen 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:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

Beachten Sie das --images= Flag, mit dem Sie den Platzhalter (my-app-image) in der Manifest- oder Dienstdefinition durch das spezifische, SHA-qualifizierte Image ersetzen. Google empfiehlt, Ihre Manifeste auf diese Weise zu templatieren und bei der Erstellung des Release SHA-qualifizierte Imagenamen zu verwenden.

Unter normalen Umständen erstellt Cloud Deploy den Rollout für das erste Ziel, wenn Sie den Release mit diesem Befehl erstellen. Da Rollouts gemäß der Bereitstellungsrichtlinie eingeschränkt sind, wird in diesem Fall kein Rollout 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"

Richtlinienbedingte Einschränkung überschreiben

Wenn Sie die Beispielanwendung bereitstellen möchten, die von der Bereitstellungsrichtlinie blockiert wird, müssen Sie diese Richtlinie überschreiben. Dazu erstellen Sie einen neuen Rollout für diesen Release und fügen dieses Mal die Option --override-deploy-policies hinzu:

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 erstellt den Rollout für prod-target.

Ergebnisse in der Google Cloud Console ansehen

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

   Zur Seite der Lieferpipelines

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

   Die Pipeline-Visualisierung zeigt den Bereitstellungsstatus der App. Da die Richtlinie überschrieben wurde, wurde der Rollout erstellt und war erfolgreich.

   

   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 auf dieser Seite verwendeten Ressourcen in Rechnung gestellt werden:

1. Löschen Sie den GKE-Cluster oder den 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. Löschen Sie die Bereitstellungsrichtlinie:

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

3. Löschen Sie die Lieferpipeline, das Ziel, den Release und den Rollout:

   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 der Bereitstellung von Anwendungen

• Erfahren Sie, wie Sie Google Cloud CI/CD-Tools kombinieren, um Software effektiv zu entwickeln und in GKE bereitzustellen.