Descripción (servicios)

En esta página, se muestra cómo configurar una descripción personalizada en tus servicios de Cloud Run. Una descripción es un texto legible opcional adjunto al servicio. Una descripción tiene un límite de 512 caracteres. Si está presente, la descripción se muestra cuando visualizas detalles de un servicio mediante gcloud run services describe.

Funciones obligatorias

Para obtener los permisos que necesitas para configurar e implementar los servicios de Cloud Run, pídele a tu administrador que te otorgue los siguientes roles de IAM:

Desarrollador de Cloud Run (roles/run.developer) en el servicio de Cloud Run
Usuario de la cuenta de servicio (roles/iam.serviceAccountUser) en la identidad del servicio

Para obtener una lista de los roles y los permisos de IAM asociados con Cloud Run, consulta los roles de IAM de Cloud Run y los permisos de IAM de Cloud Run. Si tus interfaces de servicio de Cloud Run con las APIs de Google Cloud, como las bibliotecas cliente de Cloud, consulta la guía de configuración de identidades del servicio. Para obtener más información sobre cómo otorgar roles, consulta permisos de implementación y Administra el acceso.

Configura o modifica una descripción

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

Línea de comandos

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

gcloud run deploy SERVICE --description DESCRIPTION

Reemplazar

SERVICE por el nombre del servicio de Cloud Run
DESCRIPTION por la descripción del servicio

YAML

Si creas un servicio nuevo, omite este paso. Si actualizas un servicio existente, descarga su configuración de YAML:
```
gcloud run services describe SERVICE --format export > service.yaml
```

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

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

Reemplazar

SERVICE por el nombre del servicio de Cloud Run
DESCRIPTION por la descripción del servicio

Crea o actualiza el servicio con el siguiente comando:
```
gcloud run services replace service.yaml
```

Terraform

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

El siguiente recurso google_cloud_run_v2_service especifica una descripción. Reemplaza la descripción por el valor que desees.

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-description"
  location = "us-central1"

  description = "This service has a custom description"

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"
    }
  }

}