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 eine Bereitstellung auf einem benutzerdefinierten Ziel dieses Typs vornehmen.

Dieser Schnellstart erläutert folgende Schritte:

Erstellen Sie eine Skaffold-Konfiguration.

In der Skaffold-Konfigurationsdatei konfigurieren Sie das Verhalten des Ziels. Diese Konfiguration verweist auf Container-Images und Shell-Befehle, die auf diesen Images ausgeführt werden. Das sind die Aktionen für die Render- und Bereitstellungsvorgänge.
Definieren Sie einen benutzerdefinierten Zieltyp und ein Ziel, das auf diesen Typ verweist.
Definieren Sie Ihre Cloud Deploy-Bereitstellungspipeline.

Diese Pipeline umfasst nur eine Phase und verwendet nur ein Ziel. In dieser Phase verweisen Sie auf das von Ihnen konfigurierte Ziel.
Erstellen Sie einen Release, wodurch automatisch ein Roll-out erstellt wird. Dadurch werden die benutzerdefinierten Render- und Bereitstellungsvorgänge ausgeführt.

Im Rahmen dieses Release und Roll-outs werden sowohl die in Ihrer Skaffold-Konfiguration definierten Rendering- als auch die Bereitstellungsvorgänge ausgeführt.
Ergebnisse der benutzerdefinierten Vorgänge ansehen Dazu gehören eine gerenderte Konfigurationsdatei, die in Cloud Storage hochgeladen wird, ein String, der in diese Datei geschrieben wird, sowie eine Ergebnisdatei mit dem Status des Vorgangs.

Hinweise

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.

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

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

Enable the APIs

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

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

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

Enable the APIs

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

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

gcloud components update

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.

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 jeweilige 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 vorbereiten

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

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

Hinweis: Mit den in dieser Kurzanleitung bereitgestellten benutzerdefinierten Aktionen wird keine Anwendung in einer Laufzeit bereitgestellt. Sowohl die Render- als auch die Bereitstellungsaktionen laden eine Ergebnisdatei in Cloud Storage hoch, um den Vertrag für benutzerdefinierte Ziele zwischen Cloud Deploy und dem benutzerdefinierten Rendern und Bereitstellen 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
        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
- 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
        gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json

Diese Datei enthält den Abschnitt customActions:, in dem eine benutzerdefinierte Rendering-Aktion und eine benutzerdefinierte Bereitstellungsaktion definiert werden. Jede dieser benutzerdefinierten Aktionen verweist auf ein auszuführendes Container-Image und Befehle, die in diesem Container ausgeführt werden sollen.

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

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

Erstellen Sie im Verzeichnis „custom-target-quickstart“ die neue Datei 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
customActions:
  renderAction: custom-render
  deployAction: custom-deploy

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

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.

Führen Sie folgenden Befehl im Verzeichnis custom-target-quickstart 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 (außer bei Releases mit --disable-initial-rollout) erstellt Cloud Deploy automatisch auch eine Bereitstellungsressource. Alle Phasen dieses Roll-outs werden ausgeführt, einschließlich Rendern und Bereitstellen.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten ist die Bereitstellung abgeschlossen. Da die beiden benutzerdefinierten Aktionen in diesem Fall Befehle sind, mit denen Strings in eine Datei ausgegeben und die Datei in Cloud Storage hochgeladen werden, wird nichts in einer Ziellaufzeit bereitgestellt.

Sie können sich die Datei und die Strings darin aber so ansehen:

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

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

Die Pipelinevisualisierung zeigt den Bereitstellungsstatus der App. Da es nur eine Phase in der Pipeline gibt, wird in der Visualisierung nur ein Knoten angezeigt.

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

Die Seite Release-Details wird angezeigt.
Klicken Sie auf den Tab Artefakte.
Klicken Sie unter Ziel-Artefakte auf den Link ARTEFAKTE ANSEHEN.

Die gerenderte Manifestdatei wird angezeigt. In diesem Fall ist die Datei die Ausgabe der benutzerdefinierten Renderaktion, die Sie in Ihrer skaffold.yaml-Konfigurationsdatei definiert haben und die den String „Beispiel für gerenderte Manifestinhalte“ enthält.
Hier finden Sie die Cloud Storage-Buckets, die mit dieser Version erstellt wurden.
Die Cloud Storage-Browserseite öffnen

Die Seite Buckets wird angezeigt. Darauf sind zwei für diese Version erstellte Buckets zu sehen. Ein Bucket enthält die Konfigurationsdatei der Lieferpipeline und die gerenderte skaffold.yaml. Die andere enthält die Ausgabedatei, die unsere benutzerdefinierte Aktion zum Erstellen konfiguriert ist.
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 mit dem Namen Ihres Roll-outs, der test-release-001-to-sample-env-0001 sein sollte.
Klicken Sie auf den angezeigten Ordner, der eine UUID ist, und dann auf den Ordner custom-output.
Klicken Sie auf results.json und dann auf die als Hyperlink markierte URL im Feld Authentifizierte URL.

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

Bereinigen

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

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

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!