Menetapkan deskripsi (layanan)

Halaman ini menunjukkan cara menetapkan deskripsi kustom pada layanan Cloud Run Anda. Deskripsi adalah teks opsional yang dapat dibaca oleh manusia yang dilampirkan ke layanan. Deskripsi dibatasi hingga 512 karakter. Jika ada, deskripsi akan ditampilkan saat melihat detail layanan menggunakan gcloud run services describe.

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan guna mengonfigurasi dan men-deploy layanan Cloud Run, minta administrator untuk memberi Anda peran IAM berikut:

Untuk mengetahui daftar peran dan izin IAM yang terkait dengan Cloud Run, lihat peran IAM Cloud Run dan izin IAM Cloud Run. Jika layanan Cloud Run Anda berinteraksi dengan Google Cloud API, seperti Library Klien Cloud, lihat panduan konfigurasi identitas layanan. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat izin deployment dan mengelola akses.

Menetapkan atau mengubah deskripsi

Anda dapat menetapkan deskripsi pada layanan Cloud Run.

gcloud

Anda dapat menetapkan atau memperbarui deskripsi selama deployment:

gcloud run deploy SERVICE --description DESCRIPTION

Ganti

  • SERVICE dengan nama layanan Cloud Run Anda
  • DESCRIPTION dengan deskripsi layanan

YAML

  1. Jika Anda membuat layanan baru, lewati langkah ini. Jika Anda mengupdate layanan yang sudah ada, download konfigurasi YAML-nya:

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

  2. Update anotasi run.googleapis.com/description: 

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

    Ganti

    • SERVICE dengan nama layanan Cloud Run Anda
    • DESCRIPTION dengan deskripsi layanan

  3. Buat atau perbarui layanan menggunakan perintah berikut:

    gcloud run services replace service.yaml

Terraform

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Resource berikut google_cloud_run_v2_service menentukan deskripsi. Ganti deskripsi dengan nilai yang Anda inginkan.

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"
    }
  }

}