App mit Cloud Deploy in Cloud Run bereitstellen

Auf dieser Seite wird beschrieben, wie Sie mit Cloud Deploy ein Beispielanwendungs-Image namens hello an eine Sequenz aus zwei Cloud Run-Diensten, zwei Cloud Run-Jobs oder zwei Cloud Run-Worker-Pools bereitstellen. Cloud Run-Worker-Pools befinden sich in der Vorschau.

Dieser Schnellstart erläutert folgende Schritte:

  1. Eine Skaffold-Konfiguration erstellen

  2. Konfigurationsdateien für zwei Cloud Run-Dienste, zwei Jobs oder zwei Worker-Pools erstellen.

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

  3. Definieren Sie Ihre Cloud Deploy-Lieferpipeline und Bereitstellungsziele , die auf die beiden Dienste , die beiden Jobs oder die beiden Worker-Pools 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 beide Rollouts in der Google Cloud Console anzeigen.

Hinweis

  • Melden Sie sich in Ihrem Google Cloud Konto an. Wenn Sie noch kein Konto bei Google Cloudhaben, 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.
  • 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.

    Go to project selector

  • If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

  • Verify that billing is enabled for your Google Cloud project.

  • Enable the Cloud Deploy, Cloud Build, 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
  • 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.

    Go to project selector

  • If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

  • Verify that billing is enabled for your Google Cloud project.

  • Enable the Cloud Deploy, Cloud Build, 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
  • Erforderliche Rollen

    Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Cloud Deploy Job Runner (roles/clouddeploy.jobrunner) für Ihr Projekt zu gewähren, um die Berechtigungen zu erhalten, die Sie zum Erstellen einer Cloud Deploy-Lieferpipeline und eines Release benötigen.

    Bitten Sie Ihren Administrator, dem Cloud Deploy-Dienstkonto die folgenden IAM-Rollen für Ihr Projekt zu gewähren, damit das Cloud Deploy-Dienstkonto die erforderlichen Berechtigungen zum Ausführen von Cloud Deploy-Vorgängen und zum Bereitstellen in Cloud Run hat: Bitten Sie Ihren Administrator, dem

    Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

    Ihr Administrator kann dem Cloud Deploy-Dienstkonto möglicherweise auch die erforderlichen Berechtigungen über benutzerdefinierte Rollen oder andere vordefinierte Rollen erteilen.

    Skaffold-Konfiguration vorbereiten

    Cloud Deploy verwendet Skaffold, um die Details für die Bereitstellung und die richtige Bereitstellung für Ihre separaten Ziele bereitzustellen.

    In dieser Kurzanleitung erstellen Sie eine skaffold.yaml-Datei, in der die Cloud Run-Dienst- oder Jobdefinition angegeben ist, die zum Bereitstellen der Beispiel-App 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: {}
      

      Worker-Pools (Vorschau)

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

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

    Cloud Run-Dienste, -Jobs oder -Worker-Pools vorbereiten

    In dieser Kurzanleitung erstellen Sie entweder zwei verschiedene Cloud Run-Dienste, zwei Cloud Run-Jobs oder zwei Cloud Run-Worker-Pools im selben Projekt. Cloud Deploy unterstützt auch die Bereitstellung in mehreren Projekten. Außerdem verwenden wir Skaffold-Profile, um zwei Dienste, Jobs oder Worker-Pools im selben Projekt zu haben. 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 Bereitstellungspipeline.

    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
      

      Diese Datei definiert einen weiteren Cloud Run-Dienst. Wie der Name deploy-run-service-prod schon sagt, ist dies Ihr prod Dienst und entspricht dem zweiten Ziel in Ihrer Bereitstellungspipeline.

    Diese Dateien sind 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 Release durch dasspezifische 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
      

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

    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
      

      Diese Datei definiert einen weiteren Cloud Run-Job. 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 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 Release durch das spezifische Image ersetzt wird, wenn Sie das Release erstellen.

    Worker-Pools (Vorschau)

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

      apiVersion: run.googleapis.com/v1
      kind: WorkerPool
      metadata:
        name: deploy-run-worker-pool-dev
        annotations:
          run.googleapis.com/launch-stage: BETA
      spec:
        template:
          spec:
            containers:
            - image: my-app-image
      

      Diese Datei definiert einen Cloud Run-Worker-Pool. Wie der Name deploy-run-worker-pool-dev schon sagt, ist dies Ihr dev Worker-Pool und entspricht dem ersten Ziel in Ihrer Bereitstellungspipeline.

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

      apiVersion: run.googleapis.com/v1
      kind: WorkerPool
      metadata:
        name: deploy-run-worker-pool-prod
        annotations:
          run.googleapis.com/launch-stage: BETA
      spec:
        template:
          spec:
            containers:
            - image: my-app-image
      

      Diese Datei definiert einen weiteren Cloud Run-Worker-Pool. Wie der Name deploy-run-worker-pool-prod schon sagt, ist dies Ihr prod Worker Pool und entspricht dem zweiten Ziel in Ihrer Bereitstellungspipeline Progression.

    Diese Dateien sind Cloud Run-Worker-Pool-Definitionen, die zum Bereitstellen der Anwendung verwendet werden. Das bereitzustellende Container-Image wird hier als Platzhalter my-app-image festgelegt, der beim Erstellen des Release 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 die 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 Console die Cloud Deploy Lieferpipelines-Seite auf, um eine Liste der verfügbaren Liefer pipelines 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 Release. Weitere Informationen zu diesem Lebenszyklus finden Sie unter Cloud Deploy-Dienstarchitektur.

    Führen Sie den 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
    

    Worker-Pools (Vorschau)

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

    Beachten Sie das --images= Flag, mit dem Sie den Platzhalter (my-app-image) in der Dienst-, Job- oder Worker-Pool-Definition durch das spezifische, SHA-qualifizierte Image ersetzen. Google empfiehlt, Ihre Dienst- und Jobdefinitionen auf diese Weise zu templatieren und bei der Erstellung des Release SHA-qualifizierte Image-Namen zu verwenden.

    Mit dem --skaffold-version= Flag wird die Skaffold-Version angegeben, die für die Bereitstellung verwendet werden soll. Für die Unterstützung von Cloud Run-Worker-Pools müssen Sie Skaffold-Version 2.17 oder höher 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 Ziel run-qsdev 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. Es enthält die Details des Ziels, zu dem Sie hochstufen.

    3. Klicken Sie auf Hochstufen.

      Der Release wird jetzt für die Bereitstellung in run-qsprod in die Warteschlange gestellt. Nach Abschluss der Bereitstellung wird dies in der Visualisierung der Lieferpipeline angezeigt:

      Visualisierung der Lieferpipeline in der Google Cloud -Konsole, 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 Cloud Deploy Lieferpipelines-Seite auf, um Ihre Pipeline my-run-demo-app-1 anzuzeigen.

      Zur Seite der Lieferpipelines

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

      Die Pipelinevisualisierung zeigt den Fortschritt der App durch die 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 Rollouts werden unter Rollouts angezeigt. Sie können auf einen Rollout klicken, um die Details einschließlich des Bereitstellungslogs aufzurufen.

      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 oder -Worker-Pools zuzugreifen. In der Übersicht zur Cloud Run Authentifizierung 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 Cloud Run-Dienst, -Job oder -Worker-Pool deploy-qs-dev:

      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
      

      Worker-Pools (Vorschau)

      gcloud beta run worker-pools delete deploy-run-worker-pool-dev --region=us-central1 --project=PROJECT_ID

    2. Löschen Sie den Dienst, Job oder Worker-Pool 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
      

      Worker-Pools (Vorschau)

      gcloud beta run worker-pools delete deploy-run-worker-pool-prod --region=us-central1 --project=PROJECT_ID
      
    3. Löschen Sie die Lieferpipeline, Ziele, Release und Rollouts:

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

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

      Die Cloud Storage-Browserseite öffnen

    Das war alles. Sie haben diesen Schnellstart abgeschlossen!

    Nächste Schritte