Cloud Run-Dienst, ‑Job oder ‑Worker-Pool bereitstellen

In diesem Dokument wird beschrieben, wie Sie Ihre Anwendungen bereitstellen, einschließlich Cloud Run-Diensten, Cloud Run-Jobs und Cloud Run-Worker-Pools.

Mit Cloud Deploy können Sie Ihre containerbasierten Arbeitslasten in einem beliebigen Cloud Run-Dienst, Job oder Worker-Pool bereitstellen. Alle Cloud Deploy-Funktionen werden unterstützt, wenn Sie Cloud Run-Dienste oder Worker-Pools auf Cloud Run-Ziele bereitstellen. Canary-Bereitstellungen werden jedoch für Cloud Run-Jobs nicht unterstützt.

In diesem Dokument werden die drei Hauptkonfigurationen beschrieben, die Sie für die Bereitstellung in Cloud Run vornehmen müssen:

• Zielkonfiguration erstellen
• Skaffold-Konfiguration erstellen
• Erstellen Sie Ihre Cloud Run-Dienstdefinitionen, Jobdefinitionen oder Worker-Pooldefinitionen.

Beschränkungen

• Sie können nur einen Cloud Run-Dienst, ‑Job oder ‑Worker-Pool pro Ziel bereitstellen.

• Sie können keine Canary-Bereitstellung für einen Cloud Run-Job ausführen.

  Für Cloud Run-Dienste und Worker-Pools kann jedoch ein Canary-Deployment verwendet werden.

• Wenn Sie eine Cloud Run-Funktion mit Cloud Deploy bereitstellen möchten, müssen Sie Ihren CI-Workflow ändern, um die Funktion in einem Container zu erstellen und als Cloud Run-Dienst bereitzustellen.

Hinweise

• Sie benötigen die gcloud CLI-Version 541.0.0 oder höher.

• Sie haben eine Cloud Deploy-Bereitstellungspipeline.

Zielkonfiguration erstellen

Das Ziel kann in der YAML-Datei Ihrer Lieferpipeline oder in einer separaten Datei konfiguriert werden. Außerdem können Sie in derselben Datei mehrere Ziele konfigurieren.

Ziele müssen im selben Projekt und in derselben Region wie die Bereitstellungspipeline definiert werden. Die Dienste, Jobs oder Worker-Pools, in denen die Ziele bereitgestellt werden, können sich jedoch in verschiedenen Projekten und Regionen befinden, sofern das Dienstkonto Zugriff auf diese Projekte hat.

Erstellen Sie in der Zieldefinition einen run-Abschnitt, um den Ort anzugeben, an dem der Cloud Run-Dienst erstellt wird.

Die Syntax zum Angeben des Cloud Run-Dienstes, -Jobs oder -Worker-Pools in der Zieldatei ist wie folgt:

run:
 location: projects/[project_name]/locations/[region_name]

Diese Ressourcen-ID verwendet die folgenden Elemente:

• project_name ist der Name des Google Cloud Projekts, in dem Ihr Cloud Run-Dienst, Job oder Worker-Pool erstellt wird.

  Das müssen Sie für jedes Zielvorhaben tun. Wir empfehlen, für jeden Cloud Run-Dienst, -Job oder -Worker-Pool ein separates Projekt zu verwenden. Wenn Sie mehr als einen Dienst, Job oder Worker-Pool im selben Projekt verwenden möchten, müssen Sie Skaffold-Profile in Ihrer skaffold.yaml-Konfigurationsdatei verwenden.

• region_name ist die Region, in der der Dienst, der Job oder der Worker-Pool erstellt wird. Ihr Dienst, Job oder Worker-Pool kann sich in einer beliebigen von Cloud Run unterstützten Region befinden.

Das Folgende ist ein Beispiel für eine Zielkonfiguration, in der der zu erstellende Cloud Run-Dienst, -Job oder -Worker-Pool definiert wird:

      apiVersion: deploy.cloud.google.com/v1
      kind: Target
      metadata:
       name: dev
      description: development service
      run:
       location: projects/my-app/locations/us-central1

Sie können dieses Ziel in einer Cloud Deploy-Definition der Bereitstellungspipeline oder separat definieren. In jedem Fall müssen Sie das Ziel registrieren, bevor Sie die Release erstellen, um Ihren Cloud Run-Dienst, -Job oder -Worker-Pool bereitzustellen.

Skaffold-Konfiguration erstellen

Unten sehen Sie ein Beispiel für eine skaffold.yaml-Datei für eine Cloud Run-Bereitstellung:

apiVersion: skaffold/v4beta7
kind: Config
metadata: 
  name: cloud-run-application
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}

In dieser skaffold.yaml-Datei...

• manifests.rawYaml enthält die Namen der Cloud Run-Dienstdefinitionen.

  In diesem Beispiel ist service.yaml die Datei, die einen Cloud Run-Dienst definiert, der von Skaffold bereitgestellt wird. Der Dateiname kann beliebig sein, aber standardmäßig wird service.yaml für einen Dienst, job.yaml für einen Job und workerpool.yaml für einen Worker-Pool verwendet.

• Im deploy-Abschnitt wird angegeben, wie das Manifest bereitgestellt werden soll, insbesondere das Projekt und der Standort. deploy ist erforderlich.

  Wir empfehlen, das leere {} beizubehalten. Cloud Deploy füllt diese während des Renderns basierend auf dem Projekt und dem Speicherort aus der Zieldefinition aus.

  Für die lokale Entwicklung können Sie hier jedoch Werte angeben. Cloud Deploy verwendet jedoch immer das Projekt und den Speicherort aus der Zieldefinition, unabhängig davon, ob hier Werte angegeben sind.

Cloud Run-Dienstdefinitionen erstellen

Sie können eine Cloud Run-Dienstdefinition entweder manuell erstellen oder aus einem vorhandenen Dienst kopieren. Beide werden in diesem Abschnitt beschrieben.

Option 1: Neue Cloud Run-service.yaml erstellen

In der Datei service.yaml wird Ihr Cloud Run-Dienst definiert. Wenn Sie eine Version erstellen, verwendet Skaffold diese Definition, um Ihren Dienst bereitzustellen.

Hier ein vereinfachtes Beispiel:

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
 name: [SERVICE_NAME]
spec:
 template:
  spec:
   containers:
   - image: [IMAGE_PATH]

Wobei:

• [SERVICE_NAME] ist ein Name für diesen Cloud Run-Dienst.

• [IMAGE_PATH] verweist auf das Container-Image oder die Container-Images, die Sie mit diesem Dienst bereitstellen.

Option 2: service.yaml aus einem vorhandenen Dienst mit der Google Cloud Console kopieren

Sie können einen Dienst über die Google Cloud Console erstellen oder einen vorhandenen Dienst verwenden und die service.yaml von dort kopieren.

So rufen Sie die service.yaml mit der Google Cloud CLI ab:

gcloud run services describe [service_name] --format=export

So rufen Sie die service.yaml über die Google Cloud Console ab:

1. Rufen Sie in der Google Cloud Console die Seite „Cloud Run-Dienste“ auf.

2. Wählen Sie den vorhandenen Dienst aus, dessen Definition Sie verwenden möchten.

Alternativ können Sie ein neues erstellen und es dann auswählen. Wenn Sie den Dienst auswählen, wird die Seite „Dienstdetails“ angezeigt:

1. Wählen Sie den Tab YAML aus.

2. Klicken Sie auf Bearbeiten und kopieren Sie den Inhalt der YAML-Datei in eine neue Datei mit dem Namen service.yaml in Ihrem Dateisystem, damit Skaffold sie verwenden kann, wenn Sie ein Release erstellen.

Cloud Run-Jobdefinitionen erstellen

Zum Bereitstellen einer Cloud Run-Jobdefinition können Sie entweder eine manuell erstellen oder eine aus einem vorhandenen Job kopieren. Beide werden in diesem Abschnitt beschrieben.

Beachten Sie, dass Jobs nicht unbedingt ausgeführt werden, wenn sie von Cloud Deploy bereitgestellt werden. Das unterscheidet sich von Diensten, die Anwendungen nach der Bereitstellung ausführen. Wie ein Job aufgerufen wird, hängt vom Job selbst ab.

Option 1: Neue Cloud Run-job.yaml erstellen

In der Datei job.yaml wird Ihr Cloud Run-Job definiert. Wenn Sie ein Release erstellen, verwendet Skaffold diese Definition, um den Job bereitzustellen.

Hier ein vereinfachtes Beispiel:

apiVersion: run.googleapis.com/v1
kind: Job
metadata:
 name: [JOB_NAME]
spec:
  template:
  spec:
   containers:
   - image: [IMAGE_PATH]

Wobei:

• [JOB_NAME] ist ein Name für diesen Cloud Run-Job.

• [IMAGE_PATH] verweist auf das Container-Image, das Sie für diesen Job bereitstellen.

Option 2: job.yaml aus einem vorhandenen Job über die Google Cloud -Konsole kopieren

Sie können einen Job über die Google Cloud -Konsole erstellen oder einen vorhandenen verwenden und die job.yaml von dort kopieren.

So rufen Sie die job.yaml mit der Google Cloud CLI ab:

gcloud run jobs describe [job_name] --format=export

So rufen Sie die job.yaml über die Google Cloud Console ab:

1. Rufen Sie in der Google Cloud Console die Seite „Cloud Run-Jobs“ auf.

2. Wählen Sie den vorhandenen Job aus, dessen Definition Sie verwenden möchten.

Alternativ können Sie ein neues erstellen und es dann auswählen. Wenn Sie den Job auswählen, wird die Seite „Jobdetails“ angezeigt:

1. Wählen Sie den Tab YAML aus.

2. Klicken Sie auf Bearbeiten und kopieren Sie den Inhalt der YAML-Datei in eine neue Datei mit dem Namen job.yaml in Ihrem Dateisystem, damit Skaffold sie verwenden kann, wenn Sie ein Release erstellen.

Cloud Run-Worker-Pooldefinitionen erstellen

Wenn Sie eine Cloud Run-Worker-Pool-Definition bereitstellen möchten, können Sie sie entweder manuell erstellen oder aus einem vorhandenen Worker-Pool kopieren. Beide werden in diesem Abschnitt beschrieben.

Option 1: Neue Cloud Run-workerpool.yaml erstellen

In der Datei workerpool.yaml wird Ihr Cloud Run-Worker-Pool definiert. Wenn Sie ein Release erstellen, verwendet Skaffold diese Definition, um den Worker-Pool bereitzustellen.

Hier ein vereinfachtes Beispiel:

apiVersion: run.googleapis.com/v1
kind: WorkerPool
metadata:
 name: [WORKERPOOL_NAME]
 annotations:
  run.googleapis.com/launch-stage: BETA
spec:
  template:
   spec:
    containers:
    - image: [IMAGE_PATH]

Wobei:

• [WORKERPOOL_NAME] ist ein Name für diesen Cloud Run-Worker-Pool.

• [IMAGE_PATH] verweist auf das Container-Image, das Sie für diesen Worker-Pool bereitstellen.

Option 2: workerpool.yaml aus einem vorhandenen Worker-Pool mit der Google Cloud -Konsole kopieren

Sie können einen Worker-Pool über die Google Cloud Console erstellen oder einen vorhandenen verwenden und Ihre workerpool.yaml daraus kopieren.

So rufen Sie die workerpool.yaml mit der Google Cloud CLI ab:

gcloud beta run worker-pools describe [workerpool_name] --format=export

So rufen Sie die workerpool.yaml über die Google Cloud Console ab:

1. Rufen Sie in der Google Cloud Console die Seite „Cloud Run Worker-Pools“ auf.

2. Wählen Sie den vorhandenen Worker-Pool aus, dessen Definition Sie verwenden möchten.

Alternativ können Sie ein neues erstellen und es dann auswählen. Wenn Sie den Worker-Pool auswählen, wird die Seite „Worker-Pool-Details“ angezeigt:

1. Wählen Sie den Tab YAML aus.

2. Kopieren Sie den Inhalt der YAML-Datei in eine neue Datei mit dem Namen workerpool.yaml in Ihrem Dateisystem, damit Skaffold sie verwenden kann, wenn Sie ein Release erstellen.

Zusammenfassung

Nachdem Sie die Definition für Ihren Cloud Run-Dienst, -Job oder -Worker-Pool, Ihre skaffold.yaml-Konfiguration und Ihre Cloud Deploy-Zieldefinition haben und Ihr Ziel als Cloud Deploy-Ressource registriert haben, können Sie jetzt Ihre Bereitstellungspipeline aufrufen, um ein Release zu erstellen und es durch die in der Pipeline definierte Zielabfolge zu leiten.

In der Kurzanleitung Anwendung mit Cloud Deploy in Cloud Run bereitstellen wird das alles in der Praxis gezeigt.

Verhalten von Diensten bei Überarbeitungen

Wenn Sie einen Dienst noch einmal bereitstellen, basiert die neue Überarbeitung auf dem neu bereitgestellten service.yaml. Nichts von der vorherigen Version wird beibehalten, es sei denn, es ist in der neu bereitgestellten YAML-Datei identisch. Wenn beispielsweise Konfigurationseinstellungen oder Labels in der vorherigen Überarbeitung vorhanden sind, die nicht in der neuen YAML-Datei enthalten sind, fehlen diese Einstellungen oder Labels in der neuen Überarbeitung.

Cloud Run-Jobs auslösen

Nachdem Sie einen Job bereitgestellt haben, können Sie ihn wie in der Cloud Run-Dokumentation beschrieben auslösen.

Cloud Run-Dienste, ‑Jobs und ‑Worker-Pools in mehreren Projekten bereitstellen

Wenn Sie Dienste, Jobs oder Worker-Pools bereitstellen müssen, die sich in verschiedenen Projekten befinden, benötigt Ihr Ausführungsdienstkonto die Berechtigung für den Zugriff auf die Projekte, in denen diese Dienste, Jobs oder Worker-Pools definiert sind.

Weitere Informationen finden Sie unter Cloud Deploy-Ausführungsdienstkonto und Rollen und Berechtigungen für Identity and Access Management.

Cloud Run-Funktionen bereitstellen

Cloud Run Functions erstellt Ihren Quellcode jedes Mal, wenn eine Funktion bereitgestellt wird. Aus diesem Grund kann jedes Ziel-Laufzeit-Artefakt in Ihrer Pipeline leicht unterschiedlich sein. Das widerspricht den Best Practices in Cloud Deploy. Stattdessen empfehlen wir, einen Cloud Run-Dienst direkt zu verwenden. So können Sie ein einzelnes Artefakt erstellen und in Ihren Umgebungen bereitstellen.

1. Sehen Sie in der service.yaml für Ihre Cloud Run-Funktion nach.

   Sie können ihn mit dem folgenden Befehl abrufen:

   gcloud run services describe FUNCTION_NAME \
   --format=export \
   --region=REGION \
   --project=PROJECT
   

2. Entfernen Sie die folgenden Anmerkungen, falls vorhanden:

   • run.googleapis.com/build-base-image
   • run.googleapis.com/build-name
   • run.googleapis.com/build-source-location
   • run.googleapis.com/build-enable-automatic-updates

3. Ersetzen Sie den Wert in spec.spec.containers.image durch IMAGE_TAG.

4. Erstellen Sie Ihre Bereitstellungspipeline und Ziele mit dem Cloud Run-Dienst als Ziel.

5. Trennen Sie den Build-Schritt von dem Bereitstellungsschritt in Ihrem CI-Prozess. Anstatt die Google Cloud CLI zum Bereitstellen Ihrer Funktion zu verwenden, führen Sie die folgenden Schritte aus:

   1. Funktion mit Cloud Build in einem Container erstellen:

      gcloud builds submit --pack image=REGION-docker.pkg.dev/PROJECT/cloud-run-source-deploy/IMAGE_NAME \
      --project=PROJECT \
      --region=REGION
      

   2. Release mit Cloud Deploy erstellen:

      gcloud deploy releases create RELEASE_NAME \
      --project=DEPLOY_PROJECT \
      --region=REGION \
      --delivery-pipeline=DELIVERY_PIPELINE \
      --images=IMAGE_TAG=REGION-docker.pkg.dev/PROJECT/cloud-run-source-deploy/IMAGE_NAME
      

      In diesem Befehl gilt Folgendes:

      • RELEASE_NAME ist der Name, den Sie diesem Release zuweisen. Der Name muss unter allen Releases für diese Bereitstellungspipeline eindeutig sein.

      • DEPLOY_PROJECT ist die Projekt-ID des Projekts, in dem Sie die Bereitstellungspipeline erstellt haben.

      • DELIVERY_PIPELINE ist der Name der Lieferpipeline, die die Bereitstellung dieses Releases in der Abfolge der Ziele verwaltet. Dieser Name muss mit dem name-Feld in der Pipelinedefinition übereinstimmen.

      • REGION ist der Name der Region, in der Sie den Release erstellen, z. B. us-central1. Das ist ein Pflichtfeld.

      • IMAGE_NAME ist der Name, den Sie dem Image im vorherigen Schritt beim Erstellen der Funktion gegeben haben.

Nächste Schritte

• Kurzanleitung: Anwendung in Cloud Run bereitstellen

• Weitere Informationen zum Konfigurieren von Cloud Deploy-Zielen

• Weitere Informationen zu Ausführungsumgebungen für Cloud Deploy

• Weitere Informationen zum Skaffold-Support für Cloud Run

• Weitere Informationen zu Cloud Run