Benutzerdefinierten Zieltyp definieren und verwenden

Benutzerdefinierten Zieltyp definieren und verwenden

In dieser Kurzanleitung erfahren Sie, wie Sie mit Cloud Deploy einen benutzerdefinierten Zieltyp erstellen und dann in einem benutzerdefinierten Ziel dieses Typs bereitstellen.

Dieser Schnellstart erläutert folgende Schritte:

1. Definieren Sie einen benutzerdefinierten Zieltyp, in dem Sie das Verhalten des Ziels konfigurieren. Diese Konfiguration verweist auf Container-Images sowie auf Shell-Befehle, die auf diesen Images ausgeführt werden sollen. Das sind die Aktionen für Rendering- und Bereitstellungsvorgänge.

2. Definieren Sie ein Ziel, das auf den benutzerdefinierten Zieltyp verweist.

3. Definieren Sie Ihre Cloud Deploy-Bereitstellungspipeline.

   Diese Pipeline enthält nur eine Phase und verwendet nur ein Ziel. In dieser Phase verweisen Sie auf das von Ihnen konfigurierte Ziel.

4. Erstellen Sie eine Skaffold-Konfiguration, die für das Release erforderlich ist.

5. Erstellen Sie ein Release, wodurch automatisch ein Roll-out erstellt wird und die benutzerdefinierten Rendering- und Bereitstellungsvorgänge ausgeführt werden.

   Im Rahmen dieses Releases und Roll-outs werden sowohl die Rendering- als auch die Bereitstellungsvorgänge ausgeführt, die in der Konfiguration Ihres benutzerdefinierten Zieltyps definiert sind.

6. Sehen Sie sich die Ergebnisse der benutzerdefinierten Vorgänge an. Dazu gehören eine gerenderte Konfigurationsdatei, die in Cloud Storage hochgeladen wurde, ein String, der in diese Datei geschrieben wurde, sowie eine Ergebnisdatei mit dem Status des Vorgangs.

Hinweis

Melden Sie sich in Ihrem Google Cloud Konto an. Wenn Sie noch kein Google Cloud-Konto haben, erstellen Sie eines, 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, 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
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, 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

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

Bereitstellungspipeline, benutzerdefinierten Zieltyp und Ziel erstellen

Sie können Ihre Bereitstellungspipeline, den benutzerdefinierten Zieltyp und das Ziel in einer Datei oder in separaten Dateien definieren. In dieser Kurzanleitung erstellen Sie eine einzelne Datei mit allen drei.

1. Öffnen Sie ein Terminalfenster.

2. Erstellen Sie ein neues Verzeichnis und wechseln Sie zu diesem.

   mkdir custom-target-quickstart
   cd custom-target-quickstart
   

3. Erstellen Sie im Verzeichnis `custom-target-quickstart` eine neue Datei namens clouddeploy.yaml mit folgendem Inhalt:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: custom-targets-pipeline
   serialPipeline:
     stages:
     - targetId: sample-env
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: sample-env
   customTarget:
     customTargetType: basic-custom-target
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: CustomTargetType
   metadata:
     name: basic-custom-target
   tasks:
     render:
       type: 'container'
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:484e8266c1cfc84b283bc6d4eec1f6b61223115178cce76fb59f77b223f26e8e
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo "Sample manifest rendered content" > manifest.txt
           gcloud storage cp manifest.txt $CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt
           echo {\"resultStatus\": \"SUCCEEDED\", \"manifestFile\": \"$CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
     deploy:
       type: 'container'
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:484e8266c1cfc84b283bc6d4eec1f6b61223115178cce76fb59f77b223f26e8e
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo {\"resultStatus\": \"SUCCEEDED\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
   

   Die Definition des benutzerdefinierten Zieltyps enthält den tasks Abschnitt, in dem eine Rendering- und eine Bereitstellungsaufgabe definiert sind. Jede dieser Aufgaben verweist auf ein Container-Image, das ausgeführt werden soll, und auf Befehle, die in diesem Container ausgeführt werden sollen.

   Hinweis: Der benutzerdefinierte Zieltyp und das Ziel sind in dieser Datei in der Bereitstellungs-Pipeline enthalten. Sie können sie auch in einer separaten Datei oder mehreren separaten Dateien definieren.

4. 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 Bereitstellungspipeline mit einem Ziel. Dies ist Ihr Ziel mit dem benutzerdefinierten Zieltyp. Mit dieser Pipeline wird keine Anwendung in einer Laufzeit bereitgestellt.

5. Bestätigen Sie Pipeline und Ziele:

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

   Zur Seite der Lieferpipelines

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

   

Skaffold-Konfigurationsdatei erstellen

Für das Release in dieser Kurzanleitung ist eine Skaffold-Konfigurationsdatei erforderlich, diese Datei erfordert jedoch keine aussagekräftige Konfiguration.

1. Erstellen Sie eine Datei namens skaffold.yaml mit folgendem Inhalt:

   apiVersion: skaffold/v4beta7
   kind: Config
   

Release erstellen

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

Führen Sie den folgenden Befehl im Verzeichnis custom-target-quickstart aus, um eine release-Ressource zu erstellen, die die benutzerdefinierte Bereitstellungsaktion darstellt:

gcloud deploy releases create test-release-001 \
  --project=PROJECT_ID \
  --region=us-central1 \
  --delivery-pipeline=custom-targets-pipeline

Wie bei allen Releases (sofern sie nicht --disable-initial-rollout enthalten), erstellt Cloud Deploy automatisch auch eine Roll-out-Ressource. Alle Phasen dieses Roll-outs werden ausgeführt, einschließlich Rendering und Bereitstellung.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten ist die Bereitstellung abgeschlossen. Da die beiden benutzerdefinierten Aktionen in diesem Fall Befehle sind, um Strings in eine Datei zu schreiben und die Datei in Cloud Storage hochzuladen, wird nichts in einer Ziellaufzeit bereitgestellt.

Sie können sich jedoch die Datei und die Strings in dieser Datei ansehen:

1. Rufen Sie in der Google Cloud Google Cloud Console die Cloud Deploy Lieferpipelines-Seite auf, um Ihre Bereitstellungspipeline (custom-targets-pipeline) aufzurufen.

   Zur Seite der Lieferpipelines

2. Klicken Sie auf den Namen Ihrer Bereitstellungspipeline (custom-targets-pipeline).

   Die Pipeline-Visualisierung zeigt den Bereitstellungsstatus der Anwendung. Da die Pipeline nur eine Phase hat, zeigt die Visualisierung nur einen Knoten.

   

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

3. Klicken Sie auf den Namen des Releases.

   Die Seite Release-Details wird angezeigt.

4. Klicken Sie auf den Tab Artefakte.

5. Klicken Sie unter Zielartefakte auf den Link ARTEFAKTE ANZEIGEN.

   Die gerenderte Manifestdatei wird angezeigt. In diesem Fall ist die Datei die Ausgabe der benutzerdefinierten Rendering-Aktion, die Sie in der Konfiguration des benutzerdefinierten Zieltyps definiert haben. Sie enthält den String „Sample manifest rendered content“.

   

6. Suchen Sie die Cloud Storage -Buckets, die mit diesem Release erstellt wurden.

   Die Cloud Storage-Browserseite öffnen

   Die Seite Buckets wird angezeigt und enthält zwei Buckets, die für dieses Release erstellt wurden. Ein Bucket enthält die Konfigurationsdatei der Bereitstellungspipeline und die gerenderte skaffold.yaml. Der andere enthält die Ausgabedatei, die von unserer benutzerdefinierten Aktion erstellt werden soll.

7. Klicken Sie auf den Bucket, dessen Name mit us-central1.deploy-artifacts beginnt.

   

8. Klicken Sie auf den Ordner, dessen Name mit custom-targets-pipeline- beginnt, und dann auf den Ordner test-release-001.

9. Klicken Sie auf den Ordner mit dem Namen Ihres Roll-outs, der test-release-001-to-sample-env-0001 lauten sollte.

10. Klicken Sie auf den angezeigten Ordner, der eine UUID ist, und dann auf den Ordner custom-output.

11. Klicken Sie auf results.json und dann auf die verknüpfte URL im Feld Authentifizierte URL.

    Diese Datei enthält den String, den Sie in der Definition des benutzerdefinierten Zieltyps als Ausgabe der Aktion custom-deploy konfiguriert haben:

    

Hinweis: Sie können die Rendering-Ergebnisse auch im Cloud Storage-Bucket sehen. Es ist jedoch schneller, den Release-Prüfer zu verwenden, wie in den ersten Schritten dieser Anleitung gezeigt.

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 Bereitstellungspipeline, das Ziel, das Release und den Roll-out:

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

2. 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 benutzerdefinierten Zielen.

• Verfügbare benutzerdefinierte Zieltypen

• Weitere Informationen zu Cloud Deploy.

• Grundlagen der Bereitstellung von Anwendungen