Utiliser des libellés

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Cette page explique comment définir, modifier et supprimer des libellés dans votre service Cloud Run, dans vos révisions et dans vos tâches Cloud Run. Pour Cloud Run, les libellés sont des paires clé/valeur qui sont appliquées au service, à la révision ou à la tâche. Notez que lorsque vous définissez un libellé sur un service Cloud Run, une nouvelle révision de service ou ce libellé est créé pour ce service. Le libellé n'est pas appliqué 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 ou une tâche Cloud Run :

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

Définir ou modifier des libellés

Vous pouvez définir des libellés sur les services et les tâches Cloud Run.

Pour les services Cloud Run

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

  1. Accédez à Cloud Run

  2. Cochez la case située à gauche du service sur lequel vous définissez le libellé.

  3. Assurez-vous que le panneau d'informations situé tout à droite est activé (Afficher le panneau d'informations).

  4. Cliquez sur Labels (Libellés) pour afficher le volet des libellés.

    Définir un libellé

  5. Pour modifier une valeur de clé de libellé existante, localisez le libellé et modifiez la valeur selon vos besoins.

  6. Pour définir un nouveau libellé sur le service, cliquez sur Add Label (Ajouter un libellé), puis saisissez la clé et la valeur.

  7. Cliquez sur Enregistrer.

Ligne de commande

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

Vous pouvez télécharger et afficher la configuration de service existante à l'aide de la commande gcloud run services describe --format export, qui renvoie les résultats nettoyés au format YAML. Vous pouvez ensuite modifier les champs décrits ci-dessous et importer le fichier YAML modifié à l'aide de la commande gcloud run services replace. Veillez à ne modifier que les champs indiqués.

  1. Pour afficher et télécharger la configuration, exécutez la commande suivante :

    gcloud run services describe SERVICE --format export > service.yaml
  2. 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.

  3. Remplacez la configuration du service en utilisant la commande suivante :

    gcloud run services replace service.yaml

Terraform

Ajoutez les éléments suivants à une ressource google_cloud_run_service de votre configuration Terraform, sous l'attribut template. Cette commande applique deux libellés, foo (dont la valeur est bar) et baz (dont la valeur est quux), à votre instance Cloud Run.

metadata {
  # Labels
  # https://cloud.google.com/run/docs/configuring/labels
  labels = {
    foo : "bar"
    baz : "quux"
  }
}

Pour appliquer votre configuration Terraform dans un projet Google Cloud, procédez comme suit :

  1. Lancez Cloud Shell.
  2. Définissez le projet Google Cloud auquel vous souhaitez appliquer la configuration Terraform :
    export GOOGLE_CLOUD_PROJECT=PROJECT_ID
    
  3. Créez un répertoire et ouvrez un nouveau fichier dans ce répertoire. Le nom du fichier doit comporter l'extension .tf, par exemple main.tf :
    mkdir DIRECTORY && cd DIRECTORY && nano main.tf
    
  4. Copiez l'exemple dans main.tf.
  5. Examinez et modifiez les exemples de paramètres à appliquer à votre environnement.
  6. Enregistrez vos modifications en appuyant sur Ctrl-x, puis sur y.
  7. Initialisez Terraform :
    terraform init
  8. Examinez la configuration et vérifiez que les ressources que Terraform va créer ou mettre à jour correspondent à vos attentes :
    terraform plan

    Corrigez les modifications de la configuration si nécessaire.

  9. Appliquez la configuration Terraform en exécutant la commande suivante et en saisissant yes lorsque vous y êtes invité :
    terraform apply

    Attendez que Terraform affiche le message "Apply completed!" (Application terminée).

  10. Ouvrez votre projet Google Cloud pour afficher les résultats. Dans la console Google Cloud, accédez à vos ressources dans l'interface utilisateur pour vous assurer que Terraform les a créées ou mises à jour.

Pour les jobs Cloud Run

Pour définir un libellé sur une tâche Cloud Run, procédez comme suit :

  1. Pour définir un libellé pour une nouvelle tâche, procédez comme suit :

    gcloud beta run jobs create JOB_NAME --image IMAGE_URL --labels KEY=VALUE

    Remplacer

    • JOB_NAME par le nom de votre tâche.
    • KEY par le nom de votre clé de libellé ;
    • VALUE par la valeur de la clé.
    • Remplacez IMAGE_URL par une référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/job:latest.
  2. Pour définir un libellé sur une tâche existante, procédez comme suit :

    gcloud beta run jobs update JOB_NAME --labels KEY=VALUE

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

Répertorier les services par libellé

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

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

Remplacer

  • 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

  1. Accédez à Cloud Run

  2. Cochez la case située à gauche du service duquel vous supprimez le libellé.

  3. Assurez-vous que le panneau d'informations situé tout à droite est activé (Afficher le panneau d'informations).

  4. Cliquez sur Labels (Libellés) pour afficher le volet des libellés.

  5. Localisez le libellé que vous souhaitez supprimer.

  6. 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.

  7. Cliquez sur Enregistrer.

Ligne de commande

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é.