Configurer les étiquettes

Les étiquettes Cloud Run sont des paires clé/valeur appliquées au service et aux révisions Cloud Run. Cette page explique comment définir, modifier et supprimer des étiquettes dans votre service et vos révisions Cloud Run. Notez que lorsque vous définissez une étiquette sur un service Cloud Run, une nouvelle révision de service ou cette étiquette est créée pour ce service. L'étiquette n'est pas appliquée aux révisions plus anciennes.

Voici des exemples possibles d'utilisation :

Effectuer l'allocation des coûts et la répartition de la facturation
Identifier les ressources utilisées par les équipes individuelles ou les centres de coûts
Différencier les environnements de déploiement (production, préproduction, contrôle qualité ou test)
Identifier les propriétaires et les libellés d'état
Filtrer les journaux dans Logging

Règles d'utilisation des libellés

La règle suivante s'applique à l'utilisation des libellés définis sur un service Cloud Run :

Seuls les libellés Google Cloud valides peuvent être utilisés sur Cloud Run.

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 :

Développeur Cloud Run (roles/run.developer) sur le service Cloud Run
Utilisateur du compte de service (roles/iam.serviceAccountUser) sur l'identité du service

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 API Google 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 sections Autorisations de déploiement et Gérer les accès.

Définir ou modifier des libellés

Tout changement de configuration entraîne la création d'une révision. Les révisions ultérieures obtiennent aussi automatiquement le même paramètre de configuration, à moins que vous ne le mettiez explicitement à jour.

Vous pouvez définir ou modifier des libellés à l'aide de Google Cloud Console, de la ligne de commande gcloud ou d'un fichier YAML lorsque vous déployez une nouvelle révision.

Console

Dans la console Google Cloud, accédez à Cloud Run :

Accédez à Cloud Run
Cochez la case située à gauche du service sur lequel vous définissez le libellé.
Assurez-vous que le panneau d'informations situé tout à droite est activé (Afficher le panneau d'informations).
Cliquez sur Labels (Libellés) pour afficher le volet des libellés.
Pour modifier une valeur de clé d'étiquette existante, localisez le libellé et modifiez la valeur selon vos besoins.
Pour définir un nouveau libellé sur le service, cliquez sur Add Label (Ajouter un libellé), puis saisissez la clé et la valeur.
Cliquez sur Enregistrer.

gcloud

Vous pouvez mettre à jour les libellés d'un service à l'aide de la commande suivante :

gcloud run services update SERVICE --update-labels KEY=VALUE

Pour mettre à jour plusieurs libellés, spécifiez une liste de paires clé/valeur séparées par une virgule. Notez que la commande update-labels définit une nouvelle valeur pour la clé du libellé si celui-ci existe déjà. Dans le cas contraire, elle crée un libellé.

Remplacer

SERVICE par le nom de votre service Cloud Run ;
KEY par le nom de votre clé de libellé.
VALUE par la valeur de la clé.

Vous pouvez également définir des libellés lors du déploiement :

gcloud run deploy SERVICE --image IMAGE --labels KEY=VALUE

Pour créer plusieurs libellés au cours du déploiement, spécifiez une liste de paires clé/valeur séparées par une virgule.

YAML

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
```
Mettez à jour les attributs labels à deux endroits :
```
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: SERVICE
  labels:
    LABEL: VALUE
spec:
  template:
    metadata:
      labels:
        LABEL: VALUE
      name: REVISION
```
Remplacer
- SERVICE par le nom de votre service Cloud Run ;
- LABEL par le nom du libellé ;
- VALUE par la valeur souhaitée.
- REVISION par un nouveau nom de révision ou supprimez-le (le cas échéant). Si vous indiquez un nouveau nom de révision, il doit répondre aux critères suivants :
  - Commencer par SERVICE-
  - Ne contenir que des lettres minuscules, des chiffres et -
  - Ne pas se terminer par -
  - Ne pas dépasser 63 caractères
metadata.labels définit des libellés sur l'objet de service, tandis que spec.template.metadata.label définit des libellés sur la version créée. Seuls les libellés définis sur la version sont transmis aux journaux et à la facturation.
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 Commandes Terraform de base.

L'extrait de code suivant permet d'ajouter deux étiquettes, foo (dont la valeur est bar) et baz (dont la valeur est quux), à votre instance Cloud Run, à l'aide d'une ressource google_cloud_run_v2_service dans votre configuration Terraform.

L'ajout d'étiquettes sous template permet de définir les étiquettes de la révision : seules les étiquettes définies pour la révision sont transmises aux journaux et à la facturation. Si vous ajoutez une étiquette à un emplacement autre que template, elle est définie pour le service et non pour la révision.

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

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"
    }
    # Labels
    labels = {
      foo : "bar"
      baz : "quux"
    }
  }
}

Remplacez :

la propriété name par le nom de votre service ;
la propriété location par l'emplacement utilisé pour votre service ;
la propriété image par votre image de conteneur ;
foo et baz par vos propres noms d'étiquettes ;
bar et quux par vos propres valeurs d'étiquettes.

Répertorier les services par libellé

Vous pouvez répertorier les services par étiquette à l'aide d'un filtre de la Google Cloud CLI :

  gcloud run services list --filter metadata.labels.LABEL=VALUE

Remplacez :

LABEL par le nom du libellé ;
VALUE par la valeur à inclure dans votre liste filtrée.

Supprimer un libellé sur un service

Vous pouvez supprimer des libellés d'un service à l'aide de la console ou de la ligne de commande.

Console

Dans la console Google Cloud, accédez à Cloud Run :

Accédez à Cloud Run
Cochez la case située à gauche du service duquel vous supprimez le libellé.
Assurez-vous que le panneau d'informations situé tout à droite est activé (Afficher le panneau d'informations).
Cliquez sur Labels (Libellés) pour afficher le volet des libellés.
Localisez le libellé que vous souhaitez supprimer.
Placez le curseur à droite de la zone de texte Value (Valeur) pour que le libellé affiche l'icône de la corbeille, puis cliquez sur celle-ci.
Cliquez sur Enregistrer.

gcloud

Pour effacer tous les libellés d'un service, exécutez la commande suivante :

gcloud run services update SERVICE --clear-labels

Pour supprimer des libellés spécifiques d'un service, spécifiez une liste de clés séparées par une virgule :

gcloud run services update SERVICE --remove-labels LABEL

Remplacer

SERVICE par le nom de votre service Cloud Run ;
LABEL par le nom de votre libellé.