Defina descrições de serviços

Esta página mostra como definir uma descrição personalizada nos seus serviços do Cloud Run. Uma descrição é um texto legível opcional anexado ao serviço. Uma descrição está limitada a 512 carateres. Se estiver presente, a descrição é apresentada quando visualiza os detalhes de um serviço através do gcloud run services describe.

Funções necessárias

Para receber as autorizações de que precisa para configurar e implementar serviços do Cloud Run, peça ao seu administrador para lhe conceder as seguintes funções de IAM:

Se estiver a implementar um serviço ou uma função a partir do código fonte, também tem de ter funções adicionais concedidas no seu projeto e na conta de serviço do Cloud Build.

Para ver uma lista de funções e autorizações de IAM associadas ao Cloud Run, consulte os artigos Funções de IAM do Cloud Run e Autorizações de IAM do Cloud Run. Se o seu serviço do Cloud Run interage com Google Cloud APIs, como as bibliotecas cliente da Google Cloud, consulte o guia de configuração da identidade do serviço. Para mais informações sobre a atribuição de funções, consulte as autorizações de implementação e faça a gestão do acesso.

Defina ou modifique uma descrição

Pode definir uma descrição nos serviços do Cloud Run.

gcloud

Pode definir ou atualizar a descrição durante a implementação:

gcloud run deploy SERVICE --description DESCRIPTION

Substituir

  • SERVICE com o nome do seu serviço do Cloud Run
  • DESCRIPTION com a descrição do serviço

YAML

  1. Se estiver a criar um novo serviço, ignore este passo. Se estiver a atualizar um serviço existente, transfira a respetiva configuração YAML:

    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 com o nome do seu serviço do Cloud Run
    • DESCRIPTION com a descrição do serviço

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

    gcloud run services replace service.yaml

Terraform

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

Adicione o seguinte a um recurso google_cloud_run_v2_service na sua configuração do Terraform:

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

}

Substitua a descrição pelo valor pretendido.