Benutzerdefinierten Zieltyp definieren und verwenden

In dieser Kurzanleitung erfahren Sie, wie Sie mit Cloud Deploy eine benutzerdefinierte und dann für ein benutzerdefiniertes Ziel dieses Typs bereitstellen.

Dieser Schnellstart erläutert folgende Schritte:

  1. Erstellen Sie eine Skaffold-Konfiguration.

    In der Skaffold-Konfigurationsdatei konfigurieren Sie das Verhalten des Ziels. Diese Konfiguration verweist auf Container-Images und Shell Befehle zum Ausführen für diese Images: die Aktionen zum Rendern und Bereitstellen Geschäftsabläufe.

  2. Definieren Sie einen benutzerdefinierten Zieltyp und ein Ziel, das auf diesen Typ verweist.

  3. Definieren Sie Ihre Cloud Deploy-Bereitstellungspipeline.

    Diese Pipeline enthält nur eine Phase und verwendet nur ein Ziel. Dabei beziehen Sie sich auf das von Ihnen konfigurierte Ziel.

  4. Release erstellen, der automatisch ein Rollout erstellt, was zur Folge hat, Benutzerdefinierte Rendering- und Bereitstellungsvorgänge.

    Im Rahmen dieses Release und Roll-outs wurden die Rendering- und Bereitstellungsvorgänge Skaffold-Konfiguration ausgeführt werden.

  5. Sehen Sie sich die Ergebnisse der benutzerdefinierten Vorgänge an. Dazu gehört ein gerenderter Konfigurationsdatei, die in Cloud Storage hochgeladen wurde, und einem String, der in diese Datei sowie eine Ergebnisdatei, die den Status des Vorgangs enthält.

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.

    Go to project selector

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

  4. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, 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
  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud 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, Cloud Run, 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
  12. Wenn Sie die Google Cloud CLI bereits installiert haben, achten Sie darauf, dass Sie die neueste Version:

    gcloud components update
    
  13. Achten Sie darauf, dass das Compute Engine-Standarddienstkonto ausreichend Berechtigungen hat.

    Das Dienstkonto hat möglicherweise bereits die erforderlichen Berechtigungen. Diese Schritte sind für Projekte enthalten, bei denen automatische Rollenzuweisungen für den Standarddienst deaktiviert sind Konten.

    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)")-compute@developer.gserviceaccount.com \
          --role="roles/clouddeploy.jobRunner"
      
    2. Fügen Sie die Entwicklerrolle für die jeweilige Laufzeit hinzu.
    3. Fügen Sie die Rolle iam.serviceAccountUser hinzu, die enthält die Berechtigung actAs zur Bereitstellung in der Laufzeit:
      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 zu den bereitzustellenden Elementen und deren korrekte Bereitstellung für das Ziel anzugeben.

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

Die benutzerdefinierten Aktionen in dieser Kurzanleitung werden nicht jede Anwendung zu einer Laufzeit. Sowohl bei der Rendering- als auch bei der Bereitstellung wird ein Ergebnisdatei zu Cloud Storage, um den Vertrag für benutzerdefinierte Ziele einzuhalten zwischen Cloud Deploy und dem benutzerdefinierten Rendering und Deployment.

  1. Öffnen Sie ein Terminalfenster.

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

    mkdir custom-target-quickstart
    cd custom-target-quickstart
    
  3. 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 die customActions:-Stanza, die ein benutzerdefiniertes Rendering definiert. und einer benutzerdefinierten Bereitstellungsaktion. Jede dieser benutzerdefinierten Aktionen verweist auf ein Container-Image, das ausgeführt werden soll, und Befehle, die auf diesem Container ausgeführt werden sollen.

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

Bereitstellungspipeline, benutzerdefinierten Zieltyp und Ziel erstellen

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

  1. Erstellen Sie im Verzeichnis „custom-target-quickstart“ eine 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
    
  2. 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 und diese Pipeline stellt keine Anwendung auf einem Laufzeit.

  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, wobei ein Ziel in Spalte Ziele

    Seite der Bereitstellungspipeline in der Google Cloud Console mit der Pipeline

Release erstellen

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

Führen Sie den folgenden Befehl im Verzeichnis custom-target-quickstart aus, Erstellen Sie eine release-Ressource, 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 sie enthalten --disable-initial-rollout): Cloud Deploy erstellt automatisch eine rollout-Ressource hinzu. Und alle Phasen davon Roll-out ausgeführt, einschließlich Rendering und Bereitstellung.

Ergebnisse in der Google Cloud Console ansehen

Nach einigen Minuten ist die Bereitstellung abgeschlossen. In diesem Fall, weil die beiden benutzerdefinierte Aktionen sind Befehle zum Echo von Zeichenfolgen in eine Datei und zum Hochladen der Datei in Cloud Storage wird nichts in einer Ziellaufzeit bereitgestellt.

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

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

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

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

    Visualisierung der Bereitstellungspipeline mit Erfolg

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

  3. Klicken Sie auf den Release-Namen.

    Die Seite Releasedetails wird angezeigt.

  4. Klicken Sie auf den Tab Artefakte.

  5. Klicken Sie unter Zielartefakte auf den Link ARTIFACTS ANSEHEN.

    Die gerenderte Manifestdatei wird angezeigt. In diesem Fall ist die Datei die Ausgabe der benutzerdefinierten Renderingaktion, die Sie in der skaffold.yaml-Konfiguration definiert haben -Datei, die den String "Beispielmanifest gerenderter Inhalt" enthält.

    Ausgabe der benutzerdefinierten Renderingaktion

  6. Suchen Sie die von diesem Release erstellten Cloud Storage-Buckets.

    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 für die Bereitstellungspipeline und den gerenderter skaffold.yaml. Die andere enthält die Ausgabedatei, für die Erstellung konfiguriert ist.

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

    Liste der Cloud Storage-Buckets

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

  9. Klicken Sie auf den Ordner, der Ihrem Roll-out-Namen entspricht. Er sollte test-release-001-to-sample-env-0001

  10. Klicken Sie auf den angezeigten Ordner, bei dem es sich um eine UUID handelt, und klicken Sie dann auf das custom-output Ordner.

  11. Klicken Sie auf results.json und dann im Dialogfeld Authentifiziert URL ein.

    Diese Datei enthält die Zeichenfolge, die Sie als Ausgabe des Aktion custom-deploy in Ihrem skaffold.yaml:

    Ausgabe der benutzerdefinierten Bereitstellungsaktion

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

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  2. Beide Cloud Storage-Buckets löschen, die von Cloud Deploy verwendet werden erstellt.

    Die Cloud Storage-Browserseite öffnen

Das war alles. Sie haben diesen Schnellstart abgeschlossen!

Nächste Schritte