Definir descripciones de servicios

En esta página se muestra cómo definir una descripción personalizada en los servicios de Cloud Run. Una descripción es un texto opcional legible por humanos que se adjunta al servicio. La descripción tiene un límite de 512 caracteres. Si está presente, la descripción se muestra al ver los detalles de un servicio con gcloud run services describe.

Roles obligatorios

Para obtener los permisos que necesitas para configurar e implementar servicios de Cloud Run, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos:

Si vas a desplegar un servicio o una función a partir de código fuente, también debes tener otros roles concedidos en tu proyecto y en la cuenta de servicio de Cloud Build.

Para ver una lista de los roles y permisos de gestión de identidades y accesos asociados a Cloud Run, consulta los artículos sobre roles de gestión de identidades y accesos de Cloud Run y permisos de gestión de identidades y accesos de Cloud Run. Si tu servicio de Cloud Run interactúa con APIs, como las bibliotecas de cliente de Cloud, consulta la guía de configuración de la identidad del servicio.Google Cloud Para obtener más información sobre cómo conceder roles, consulta los artículos sobre permisos de implementación y gestión del acceso.

Definir o modificar una descripción

Puedes definir una descripción en los servicios de Cloud Run.

gcloud

Puedes definir o actualizar la descripción durante la implementación:

gcloud run deploy SERVICE --description DESCRIPTION

Sustituir

  • SERVICE con el nombre de tu servicio de Cloud Run
  • DESCRIPTION con la descripción del servicio

YAML

  1. Si va a crear un servicio, puede saltarse este paso. Si va a actualizar un servicio, descargue su configuración YAML:

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

  2. Actualiza la anotación de run.googleapis.com/description:

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

    Sustituir

    • SERVICE con el nombre de tu servicio de Cloud Run
    • DESCRIPTION con la descripción del servicio

  3. Crea o actualiza el servicio con el siguiente comando:

    gcloud run services replace service.yaml

Terraform

Para saber cómo aplicar o quitar una configuración de Terraform, consulta Comandos básicos de Terraform.

Añade lo siguiente a un recurso google_cloud_run_v2_service en tu configuración de 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"
    }
  }

}

Sustituye la descripción por el valor que quieras.