서비스 설명 설정

이 페이지에서는 Cloud Run 서비스에서 커스텀 설명을 설정하는 방법을 보여줍니다. 설명은 서비스에 연결된 인간이 읽을 수 있는 선택적 텍스트입니다. 설명은 512자로 제한됩니다. 설명이 있는 경우 gcloud run services describe을 사용하여 서비스의 세부정보를 볼 때 표시됩니다.

필요한 역할

Cloud Run 서비스를 구성하고 배포하는 데 필요한 권한을 얻으려면 관리자에게 다음 IAM 역할을 부여해 달라고 요청하세요.

소스 코드에서 서비스 또는 함수를 배포하는 경우 프로젝트 및 Cloud Build 서비스 계정에 추가 역할이 부여되어 있어야 합니다.

Cloud Run과 연결된 IAM 역할 및 권한 목록은 Cloud Run IAM 역할 및 Cloud Run IAM 권한을 참조하세요. Cloud Run 서비스가 Cloud 클라이언트 라이브러리와 같은Google Cloud API와 상호작용하는 경우에는 서비스 ID 구성 가이드를 참조하세요. 역할 부여 방법에 대한 자세한 내용은 배포 권한 및 액세스 관리를 참조하세요.

설명 설정 또는 수정

Cloud Run 서비스에 대한 설명을 설정할 수 있습니다.

gcloud

배포 중 설명을 설정하거나 업데이트할 수 있습니다.

gcloud run deploy SERVICE --description DESCRIPTION

다음과 같이 바꿉니다.

  • SERVICE를 Cloud Run 서비스 이름으로 바꿉니다.
  • DESCRIPTION을 서비스 설명으로 바꿉니다.

YAML

  1. 새 서비스를 만드는 경우에는 이 단계를 건너뜁니다. 기존 서비스를 업데이트하는 경우 YAML 구성을 다운로드합니다.

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

  2. run.googleapis.com/description 주석을 업데이트합니다.

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

    다음과 같이 바꿉니다.

    • SERVICE를 Cloud Run 서비스 이름으로 바꿉니다.
    • DESCRIPTION을 서비스 설명으로 바꿉니다.

  3. 다음 명령어를 사용하여 서비스를 만들거나 업데이트합니다.

    gcloud run services replace service.yaml

Terraform

Terraform 구성을 적용하거나 삭제하는 방법은 기본 Terraform 명령어를 참조하세요.

Terraform 구성에서 다음을 google_cloud_run_v2_service 리소스에 추가합니다.

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

}

설명을 원하는 값으로 바꿉니다.