Diese Seite wurde von der Cloud Translation API übersetzt.

Benutzerdefinierten Zieltyp definieren und verwenden

In dieser Kurzanleitung erfahren Sie, wie Sie mit Cloud Deploy einen benutzerdefinierten Zieltyp erstellen und dann für ein benutzerdefiniertes Ziel dieses Typs bereitstellen.

Dieser Schnellstart erläutert folgende Schritte:

Erstellen Sie eine Skaffold-Konfiguration.

In der Skaffold-Konfigurationsdatei können Sie das Verhalten des Ziels konfigurieren. Diese Konfiguration verweist auf Container-Images und Shell-Befehle, die auf diesen Images ausgeführt werden. Dies sind die Aktionen für Rendering- und Bereitstellungsvorgänge.
Definieren Sie einen benutzerdefinierten Zieltyp und ein Ziel, das auf diesen Typ verweist.
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.
Erstellen Sie einen Release. Dadurch wird automatisch ein Roll-out erstellt, wodurch die benutzerdefinierten Rendering- und Bereitstellungsvorgänge ausgeführt werden.

Im Rahmen dieses Release und Roll-outs werden die in Ihrer Skaffold-Konfiguration definierten Rendering- und Bereitstellungsvorgänge ausgeführt.
Sehen Sie sich die Ergebnisse der benutzerdefinierten Vorgänge an. Dazu gehören eine in Cloud Storage hochgeladene gerenderte Konfigurationsdatei, ein in diese Datei geschriebener String sowie eine Ergebnisdatei mit dem Status des Vorgangs.

Hinweise

Melden Sie sich bei Ihrem Google Cloud-Konto an. Wenn Sie mit Google Cloud noch nicht vertraut sind, 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.

Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

Zur Projektauswahl

Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs aktivieren.

Aktivieren Sie die APIs

Installieren Sie die Google Cloud CLI.

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

gcloud init

Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

Zur Projektauswahl

Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs aktivieren.

Aktivieren Sie die APIs

Installieren Sie die Google Cloud CLI.

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

gcloud init

Wenn Sie die Google Cloud CLI bereits installiert haben, prüfen Sie, ob es sich um die neueste Version handelt:

gcloud components update

Prüfen Sie, ob das Compute Engine-Standarddienstkonto die erforderlichen Berechtigungen hat.
Das Dienstkonto hat möglicherweise bereits die erforderlichen Berechtigungen. Diese Schritte sind für Projekte enthalten, bei denen automatische Rollenzuweisungen für Standarddienstkonten deaktiviert werden.

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"

Fügen Sie die Entwicklerrolle für Ihre spezifische Laufzeit hinzu.

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

Skaffold-Konfiguration und Anwendungsmanifest vorbereiten

Cloud Deploy verwendet Skaffold, um Details für die Bereitstellung und die Bereitstellung für Ihr Ziel bereitzustellen.

In dieser Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, in der benutzerdefinierte Aktionen definiert sind, die die Rendering- und Bereitstellungsvorgänge für den benutzerdefinierten Zieltyp darstellen.

Mit den benutzerdefinierten Aktionen in dieser Kurzanleitung wird keine Anwendung tatsächlich für eine Laufzeit bereitgestellt. Sowohl für die Rendering- als auch für die Bereitstellungsaktionen wird eine Ergebnisdatei in Cloud Storage hochgeladen, um den Vertrag mit benutzerdefinierten Zielen zwischen Cloud Deploy und dem benutzerdefinierten Rendering und Deployment zu erfüllen.

Öffnen Sie ein Terminalfenster.

Erstellen Sie ein neues Verzeichnis und rufen Sie es auf.

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

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

apiVersion: skaffold/v4beta7
kind: Config
customActions:
- name: custom-render
  containers:
  - name: render
    image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
    command: ['/bin/bash']
    args:
      - '-c'
      - |-
        echo "Sample manifest rendered content" > manifest.txt
        gsutil cp manifest.txt $CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt
        echo {\"resultStatus\": \"SUCCEEDED\", \"manifestFile\": \"$CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt\"} > results.json
        gsutil cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
- name: custom-deploy
  containers:
  - name: deploy
    image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
    command: ['/bin/bash']
    args:
      - '-c'
      - |-
        echo {\"resultStatus\": \"SUCCEEDED\"} > results.json
        gsutil cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json

Diese Datei enthält die Stanza customActions:, mit der eine benutzerdefinierte Renderingaktion und eine benutzerdefinierte Bereitstellungsaktion definiert werden. Jede dieser benutzerdefinierten Aktionen verweist auf ein Container-Image, das ausgeführt werden soll, und auf Befehle, die in diesem Container ausgeführt werden sollen.

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

Bereitstellungspipeline, benutzerdefinierten Zieltyp und Ziel erstellen

Sie können die 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 Dateien.

Erstellen Sie im Verzeichnis clouddeploy.yaml eine neue Datei 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
customActions:
  renderAction: custom-render
  deployAction: custom-deploy

Registrieren Sie Ihre Pipeline und Ziele mit dem 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. Diese Pipeline stellt keine Anwendung in einer Laufzeit bereit.
Bestätigen Sie Pipeline und Ziele:

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

Zur Seite der Lieferpipelines

Die soeben erstellte Bereitstellungspipeline wird angezeigt, mit einem Ziel in der Spalte Ziele.

Release erstellen

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

Führen Sie im Verzeichnis custom-target-quickstart den folgenden Befehl aus, um eine release-Ressource zu erstellen, die die bereitzustellende benutzerdefinierte Aktion 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 eine Rollout-Ressource. Alle Phasen des Rollouts werden ausgeführt, einschließlich Rendering und Bereitstellung.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten ist die Bereitstellung abgeschlossen. Da es sich bei den beiden benutzerdefinierten Aktionen um Befehle zum Echo von Strings in einer Datei und Hochladen der Datei in Cloud Storage handelt, wird nichts in einer Ziellaufzeit bereitgestellt.

Sie können jedoch die Datei und die darin enthaltenen Strings aufrufen:

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

Zur Seite der Lieferpipelines
Klicken Sie auf den Namen Ihrer Bereitstellungspipeline (custom-targets-pipeline).

Die Pipelinevisualisierung zeigt den Bereitstellungsstatus der Anwendung. Da es in der Pipeline nur eine Phase gibt, zeigt die Visualisierung nur einen Knoten.

Ihre Version wird auf dem Tab Releases unter Details zur Lieferpipeline aufgeführt.
Klicken Sie auf den Release-Namen.

Die Seite Releasedetails wird angezeigt.
Klicken Sie auf den Tab Artefakte.
Klicken Sie unter Zielartefakte auf den Link ARTIFACTS ANZEIGEN.

Die gerenderte Manifestdatei wird angezeigt. In diesem Fall ist die Datei die Ausgabe der benutzerdefinierten Renderingaktion, die Sie in der Konfigurationsdatei skaffold.yaml definiert haben. Sie enthält den String „Beispiel für gerenderten Inhalt eines Manifests“.
Suchen Sie die in diesem Release erstellten Cloud Storage-Buckets.
Die Cloud Storage-Browserseite öffnen

Die Seite Buckets wird angezeigt. Sie enthält zwei Buckets, die für diesen Release erstellt wurden. Ein Bucket enthält die Konfigurationsdatei der Bereitstellungspipeline und das gerenderte skaffold.yaml. Das andere enthält die Ausgabedatei, die unsere benutzerdefinierte Aktion erstellt.
Klicken Sie auf den Bucket, dessen Name mit us-central1.deploy-artifacts beginnt...
Klicken Sie auf den Ordner, dessen Name mit custom-targets-pipeline- beginnt, und dann auf den Ordner test-release-001.
Klicken Sie auf den Ordner, dessen Name dem Roll-out-Namen entspricht, also test-release-001-to-sample-env-0001 sein sollte.
Klicken Sie auf den angezeigten Ordner, bei dem es sich um eine UUID handelt, und klicken Sie dann auf den Ordner custom-output.
Klicken Sie auf results.json und dann im Feld Authentifizierte URL auf die Hyperlink-URL.

Diese Datei enthält den String, den Sie als Ausgabe der Aktion custom-deploy in Ihrem skaffold.yaml konfiguriert haben:

Bereinigen

Mit den folgenden Schritten vermeiden Sie, dass Ihrem Google Cloud-Konto die auf dieser Seite verwendeten Ressourcen in Rechnung gestellt werden.

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

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!