Definir descrições (serviços)

Nesta página, mostramos como definir uma descrição personalizada nos serviços do Cloud Run. A descrição é um texto legível opcional anexado ao serviço. A descrição é limitada a 512 caracteres. Se presente, a descrição é exibida durante a visualização de detalhes de um serviço usando gcloud run services describe.

Funções exigidas

Para receber as permissões necessárias para configurar e implantar os serviços do Cloud Run, peça ao administrador para conceder a você os seguintes papéis do IAM:

Para uma lista de papéis e permissões do IAM associados ao Cloud Run, consulte Papéis do IAM do Cloud Run e Permissões do IAM do Cloud Run. Se o serviço do Cloud Run interage com as APIs do Google Cloud, como as bibliotecas de cliente do Cloud, consulte o guia de configuração de identidade de serviço. Para mais informações sobre como conceder papéis, consulte permissões de implantação e gerenciar acesso.

Definir ou modificar uma descrição

É possível definir uma descrição nos serviços do Cloud Run.

gcloud

É possível definir ou atualizar a descrição durante a implantação:

gcloud run deploy SERVICE --description DESCRIPTION

Substituir

  • SERVICE pelo nome do serviço do Cloud Run;
  • DESCRIPTION pela descrição do serviço.

YAML

  1. Se você estiver criando um novo serviço, pule esta etapa. Se você estiver atualizando um serviço, faça o download da configuração YAML correspondente:

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

  2. Atualize a anotação run.googleapis.com/description:

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

    Substituir

    • SERVICE pelo nome do serviço do Cloud Run;
    • DESCRIPTION pela descrição do serviço.

  3. Crie ou atualize o serviço usando o seguinte comando:

    gcloud run services replace service.yaml

Terraform

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

O recurso google_cloud_run_v2_service a seguir especifica uma descrição. Substitua a descrição pelo valor desejado.

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

}