Beschreibungen festlegen (Dienste)

Auf dieser Seite wird beschrieben, wie Sie eine benutzerdefinierte Beschreibung für Ihre Cloud Run-Dienste festlegen. Eine Beschreibung ist ein optionaler für Menschen lesbarer Text, der an den Dienst angehängt ist. Beschreibungen sind auf 512 Zeichen beschränkt. Falls vorhanden, wird die Beschreibung beim Aufrufen der Details zu einem Dienst mit gcloud run services describe angezeigt.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Konfigurieren und Bereitstellen von Cloud Run-Diensten benötigen:

Eine Liste der IAM-Rollen und -Berechtigungen im Zusammenhang mit Cloud Run finden Sie unter IAM-Rollen für Cloud Run und IAM-Berechtigungen für Cloud Run. Wenn Ihr Cloud Run Service mit Google Cloud APIs wie Cloud-Clientbibliotheken verknüpft ist, lesen Sie die Konfigurationsanleitung für Dienstidentitäten. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Bereitstellungsberechtigungen und Zugriff verwalten.

Beschreibung festlegen oder ändern

Sie können eine Beschreibung für Cloud Run-Dienste festlegen.

gcloud

Sie können die Beschreibung während der Bereitstellung festlegen oder aktualisieren:

gcloud run deploy SERVICE --description DESCRIPTION

Ersetzen

  • SERVICE durch den Namen Ihres Cloud Run-Dienstes
  • DESCRIPTION durch die Beschreibung des Dienstes

YAML

  1. Wenn Sie einen neuen Dienst erstellen, überspringen Sie diesen Schritt. Wenn Sie einen vorhandenen Dienst aktualisieren, laden Sie die zugehörige YAML-Konfiguration herunter:

    gcloud run services describe SERVICE --format export > service.yaml

  2. Aktualisieren Sie die Annotation run.googleapis.com/description:

    apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: SERVICE
  annotations:
    run.googleapis.com/description: "DESCRIPTION"
spec:
  template:
    ...

    Ersetzen

    • SERVICE durch den Namen Ihres Cloud Run-Dienstes
    • DESCRIPTION durch die Beschreibung des Dienstes

  3. Erstellen oder aktualisieren Sie den Dienst mit dem folgenden Befehl:

    gcloud run services replace service.yaml

Terraform

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Die folgende google_cloud_run_v2_service-Ressource gibt eine Beschreibung an. Ersetzen Sie die Beschreibung durch den gewünschten Wert.

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-description"
  location = "us-central1"

  description = "This service has a custom description"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"
    }
  }

}