Anwendung mit Cloud Deploy in Cloud Run bereitstellen

Auf dieser Seite erfahren Sie, wie Sie mit Cloud Deploy ein Beispielanwendungs-Image namens hello an eine Sequenz aus zwei Cloud Run-Diensten oder zwei Cloud Run-Jobs bereitstellen.

Dieser Schnellstart erläutert folgende Schritte:

  1. Skaffold-Konfiguration erstellen

  2. Erstellen Sie Konfigurationsdateien für zwei Cloud Run-Dienste oder zwei Jobs.

    In diesen Dateien werden die Dienste oder Jobs definiert und die (vordefinierten) Container-Images angegeben, die bereitgestellt werden sollen.

  3. Definieren Sie Ihre Cloud Deploy-Lieferpipeline und Bereitstellungsziele, die auf die beiden Dienste oder die beiden Jobs verweisen.

  4. Instanziieren Sie Ihre Lieferpipeline. Dazu erstellen Sie einen Release, der automatisch für das erste Ziel bereitgestellt wird.

  5. Release zum zweiten Ziel hochstufen.

  6. Lassen Sie sich beide Rollouts in der Google Cloud -Konsole anzeigen.

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, Cloud Run, and Cloud Storage APIs.

    Enable the APIs

  5. Install the Google Cloud CLI.

  6. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  7. To initialize the gcloud CLI, run the following command:

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

    Go to project selector

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

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

    Enable the APIs

  11. Install the Google Cloud CLI.

  12. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  13. To initialize the gcloud CLI, run the following command:

    gcloud init
  14. Wenn Sie die CLI bereits installiert haben, prüfen Sie, ob Sie die aktuelle Version verwenden:

    gcloud components update
    

  15. Prüfen Sie, ob das Compute Engine-Standarddienstkonto 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. Rolle clouddeploy.jobRunner hinzufügen

      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. Gewähren Sie dem Standarddienstkonto für die Ausführung actAs die Berechtigung zum Bereitstellen von Arbeitslasten in Cloud Run:

      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
      

    3. Fügen Sie die Cloud Run-Entwicklerberechtigungen 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/run.developer"
      

      Wenn Sie Probleme beim Hinzufügen einer dieser Rollen haben, wenden Sie sich an Ihren Projektadministrator.

Skaffold-Konfiguration vorbereiten

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

Für diese Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, in der die Cloud Run-Dienst- oder Jobdefinition angegeben wird, die zum Bereitstellen der Beispielanwendung verwendet werden soll.

  1. Öffnen Sie ein Terminalfenster.

  2. Erstellen Sie ein neues Verzeichnis mit dem Namen deploy-run-quickstart und rufen Sie dieses Verzeichnis auf.

    mkdir deploy-run-quickstart
    cd deploy-run-quickstart
    
  3. Erstellen Sie eine Datei mit dem Namen skaffold.yaml und mit folgendem Inhalt:

    Dienste

    apiVersion: skaffold/v4beta7
    kind: Config
    metadata: 
      name: deploy-run-quickstart
    profiles:
    - name: dev
      manifests:
        rawYaml:
        - run-service-dev.yaml
    - name: prod
      manifests:
        rawYaml:
        - run-service-prod.yaml
    deploy:
      cloudrun: {}
    

    Jobs

    apiVersion: skaffold/v4beta7
    kind: Config
    metadata: 
      name: deploy-run-quickstart
    profiles:
    - name: dev
      manifests:
        rawYaml:
        - run-job-dev.yaml
    - name: prod
      manifests:
        rawYaml:
        - run-job-prod.yaml
    deploy:
      cloudrun: {}
    

    Diese Datei ist eine minimale Skaffold-Konfiguration, die Ihre Cloud Run-Dienste oder -Jobs identifiziert. Weitere Informationen zu dieser Datei finden Sie in der skaffold.yaml-Referenz.

Cloud Run-Dienste oder -Jobs vorbereiten

Für diese Kurzanleitung erstellen Sie entweder zwei verschiedene Cloud Run-Dienste oder zwei Cloud Run-Jobs im selben Projekt. Cloud Deploy unterstützt auch die Bereitstellung in mehreren Projekten. Außerdem verwenden wir Skaffold-Profile, um zwei Dienste oder Jobs im selben Projekt zu ermöglichen. Wenn Sie verschiedene Projekte verwenden, müssen Sie möglicherweise keine Skaffold-Profile verwenden.

Dienste

  1. Erstellen Sie eine Datei mit dem Namen run-service-dev.yaml und mit folgendem Inhalt:

    apiVersion: serving.knative.dev/v1
    kind: Service
    metadata:
      name: deploy-run-service-dev
    spec:
      template:
        spec:
          containers:
          - image: my-app-image
    

    Diese Datei definiert einen Cloud Run-Dienst. Wie der Name deploy-run-service-dev schon sagt, ist dies Ihr dev-Dienst und entspricht dem ersten Ziel in Ihrer Zustellungspipeline.

  2. Erstellen Sie eine Datei mit dem Namen run-service-prod.yaml und mit folgendem Inhalt:

    apiVersion: serving.knative.dev/v1
    kind: Service
    metadata:
      name: deploy-run-service-prod
    spec:
      template:
        spec:
          containers:
          - image: my-app-image
    

    In dieser Datei wird ein weiterer Cloud Run-Dienst definiert. Wie der Name deploy-run-service-prod schon sagt, handelt es sich um Ihren prod-Dienst, der dem zweiten Ziel in Ihrer Fortschrittspipeline für die Bereitstellung entspricht.

Diese Dateien sind einfache Cloud Run-Dienstdefinitionen, die zum Bereitstellen der Anwendung verwendet werden. Das bereitzustellende Container-Image wird hier als Platzhalter my-app-image festgelegt, der beim Erstellen des Releases durch das spezifische Image ersetzt wird.

Jobs

  1. Erstellen Sie eine Datei mit dem Namen run-job-dev.yaml und mit folgendem Inhalt:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: deploy-run-job-dev
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: my-app-image
    

    In dieser Datei wird ein Cloud Run-Job definiert. Wie der Name deploy-run-job-dev schon sagt, handelt es sich um Ihren dev-Job, der dem ersten Ziel in Ihrer Zustellungspipeline entspricht.

  2. Erstellen Sie eine Datei mit dem Namen run-job-prod.yaml und mit folgendem Inhalt:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: deploy-run-job-prod
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: my-app-image
    

    In dieser Datei wird ein weiterer Cloud Run-Job definiert. Wie der Name deploy-run-job-prod schon sagt, ist dies Ihr prod-Job und entspricht dem zweiten Ziel in Ihrer Bereitstellungspipeline.

Diese Dateien sind einfache Cloud Run-Jobdefinitionen, die zum Bereitstellen der Anwendung verwendet werden. Das bereitzustellende Container-Image wird hier als Platzhalter my-app-image festgelegt, der beim Erstellen des Releases durch das spezifische Image ersetzt wird.

Lieferpipeline und Ziele erstellen

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

  1. Erstellen Sie im Verzeichnis deploy-run-quickstart eine neue Datei: clouddeploy.yaml mit folgendem Inhalt:

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: my-run-demo-app-1
    description: main application pipeline
    serialPipeline:
      stages:
      - targetId: run-qsdev
        profiles: [dev]
      - targetId: run-qsprod
        profiles: [prod]
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-qsdev
    description: Cloud Run development service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-qsprod
    description: Cloud Run production service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    
  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 Pipeline mit Zielen und können Ihre Anwendung für das erste Ziel bereitstellen.

  3. Bestätigen Sie Pipeline und Ziele:

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

    Zur Seite der Lieferpipelines

    Die soeben erstellte Lieferpipeline wird angezeigt und die beiden Ziele werden in der Spalte Ziele aufgeführt.

    Lieferpipeline in der Google Cloud Console

Release erstellen

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

Führen Sie folgenden Befehl im Verzeichnis deploy-run-quickstart aus, um eine release-Ressource zu erstellen, die das bereitzustellende Container-Image darstellt:

Dienste

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

Jobs

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/job@sha256:8eb3f5e72586de6375abe95aa67511c57c61d35fb37d5670e4d68624a68ef916

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

Wie bei allen Releases (sofern sie nicht --disable-initial-rollout enthalten) erstellt Cloud Deploy automatisch auch eine Rollout-Ressource. Die Anwendung wird automatisch für das erste Ziel in der Sequenz bereitgestellt.

Release hochstufen

  1. Klicken Sie auf der Seite Lieferpipelines auf die Pipeline my-run-demo-app-1.

    Zur Seite der Lieferpipelines

    Die Seite mit den Details der Lieferpipeline zeigt eine grafische Darstellung des Fortschritts der Lieferpipeline. In diesem Fall wird gezeigt, dass die Version am run-qsdev-Ziel bereitgestellt wurde.

    Visualisierung der Lieferpipeline in der Google Cloud Console

  2. Klicken Sie für das erste Ziel in der Visualisierung der Lieferpipeline auf Hochstufen.

    Das Dialogfeld Release hochstufen wird angezeigt. Hier werden die Details des Ziels angezeigt, das Sie bewerben.

  3. Klicken Sie auf Hochstufen.

    Der Release wird jetzt für die Bereitstellung in run-qsprod in die Warteschlange gestellt. Wenn die Bereitstellung abgeschlossen ist, wird sie in der Visualisierung der Lieferpipeline als bereitgestellt angezeigt:

    Visualisierung der Lieferpipeline in der Google Cloud Console, in der die in der Produktionsumgebung bereitgestellte Version zu sehen ist.

Ergebnisse in der Google Cloud -Console ansehen

  1. Rufen Sie in der Google Cloud Console die Google Cloud Deploy-Seite Bereitstellungspipelines auf, um Ihre Bereitstellungspipeline my-run-demo-app-1 aufzurufen.

    Zur Seite der Lieferpipelines

  2. Klicken Sie auf den Namen der Lieferpipeline „my-run-demo-app-1“.

    Die Pipelinevisualisierung zeigt den Fortschritt der App in der Pipeline.

    Visualisierung der Lieferpipeline in der Google Cloud Console

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

  3. Klicken Sie auf den Releasenamen, test-release-001.

    Ihre Roll-outs werden unter Roll-outs angezeigt. Sie können auf einen Roll-out klicken, um die Details aufzurufen, einschließlich des Bereitstellungslogs.

    Roll-outs in der Google Cloud Console

Auf Ihren Cloud Run-Dienst zugreifen

Standardmäßig müssen Sie authentifiziert sein, um auf neu erstellte Cloud Run-Dienste zuzugreifen. In der Cloud Run-Authentifizierungsübersicht erfahren Sie, wie Sie Anmeldedaten angeben und welche Identity and Access Management-Konfiguration erforderlich ist, um ohne Authentifizierung auf den Dienst zuzugreifen. Dies gilt nicht für Cloud Run-Jobs.

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 deploy-qs-dev Cloud Run-Dienst oder -Job:

    Dienste

    gcloud run services delete deploy-run-service-dev --region=us-central1 --project=PROJECT_ID
    

    Jobs

    gcloud run jobs delete deploy-run-job-dev --region=us-central1 --project=PROJECT_ID
    
  2. So löschen Sie den Dienst deploy-qs-prod:

    Dienste

    gcloud run services delete deploy-run-service-prod --region=us-central1 --project=PROJECT_ID
    

    Jobs

    gcloud run jobs delete deploy-run-job-prod --region=us-central1 --project=PROJECT_ID
    
  3. Löschen Sie die Bereitstellungspipeline, die Ziele, das Release und die Roll-outs:

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  4. Löschen Sie die Cloud Storage-Buckets, die von Cloud Deploy erstellt wurden.

    Eine endet mit _clouddeploy und die andere ist [region].deploy-artifacts.[project].appspot.com.

    Die Cloud Storage-Browserseite öffnen

Das war alles. Sie haben diesen Schnellstart abgeschlossen!

Nächste Schritte