Définir des descriptions de service

Cette page explique comment spécifier une description personnalisée sur vos services Cloud Run. Une description est un texte facultatif associé au service, rédigé dans un format lisible. Une description ne peut pas comporter plus de 512 caractères. Si elle a été spécifiée, la description s'affiche lorsque vous consultez les détails d'un service à l'aide de la commande gcloud run services describe.

Rôles requis

Pour obtenir les autorisations nécessaires pour configurer et déployer des services Cloud Run, demandez à votre administrateur de vous accorder les rôles IAM suivants :

Si vous déployez un service ou une fonction à partir du code source, vous devez également disposer de rôles supplémentaires dans votre projet et votre compte de service Cloud Build.

Pour obtenir la liste des rôles et des autorisations IAM associés à Cloud Run, consultez les sections Rôles IAM Cloud Run et Autorisations IAM Cloud Run. Si votre service Cloud Run communique avec les APIGoogle Cloud , telles que les bibliothèques clientes Cloud, consultez le guide de configuration de l'identité du service. Pour en savoir plus sur l'attribution de rôles, consultez les pages Autorisations de déploiement et Gérer les accès.

Spécifier ou modifier une description

Vous pouvez spécifier une description sur des services Cloud Run.

gcloud

Vous pouvez spécifier ou mettre à jour la description lors du déploiement :

gcloud run deploy SERVICE --description DESCRIPTION

Remplacer

  • SERVICE par le nom de votre service Cloud Run ;
  • DESCRIPTION par la description du service.

YAML

  1. Si vous créez un service, ignorez cette étape. Si vous mettez à jour un service existant, téléchargez sa configuration YAML :

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

  2. Mettez à jour l'annotation run.googleapis.com/description :

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

    Remplacer

    • SERVICE par le nom de votre service Cloud Run
    • DESCRIPTION par la description du service.

  3. Créez ou mettez à jour le service à l'aide de la commande suivante :

    gcloud run services replace service.yaml

Terraform

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Ajoutez les éléments suivants à une ressource google_cloud_run_v2_service dans votre configuration 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"
    }
  }

}

Remplacez la description par la valeur souhaitée.