Cloud Key Management Service offre la possibilité d'ajouter des libellés à vos clés Cloud KMS. Les libellés sont des paires clé/valeur que vous pouvez utiliser pour regrouper les clés Cloud KMS associées et les métadonnées de stockage relatives à une clé Cloud KMS.
Ils sont également inclus à votre facture, ce qui vous permet de constater la distribution des coûts en fonction des libellés.
Vous pouvez ajouter, mettre à jour et supprimer des libellés de clés à l'aide de la Google Cloud CLI et de l'API REST Cloud KMS.
Vous pouvez utiliser des libellés avec d'autres ressources Google Cloud, comme les ressources de machine virtuelle et les buckets de stockage. Pour en savoir plus sur l'utilisation des libellés dans Google Cloud, consultez la page Créer et gérer des libellés.
Qu'est-ce qu'un libellé ?
Un libellé est une paire clé-valeur que vous pouvez attribuer aux clés Cloud KMS de Google Cloud. Elle vous aide à organiser ces ressources et à gérer vos coûts à grande échelle avec la précision dont vous avez besoin. Vous pouvez associer une étiquette à chaque ressource, puis filtrer les ressources par étiquette. Les informations sur les étiquettes sont transmises au système de facturation. Ainsi, vous pouvez trier vos frais facturés par étiquette. Grâce aux rapports de facturation intégrés, vous pouvez filtrer et regrouper les coûts par étiquette de ressource. Vous pouvez également utiliser des étiquettes pour interroger les exportations de données de facturation.
Exigences relatives aux libellés
Les libellés appliqués à une ressource doivent répondre aux exigences suivantes :
- Chaque ressource peut comporter jusqu'à 64 étiquettes.
- Chaque libellé doit correspondre à une paire clé/valeur.
- Les clés doivent comporter un (1) caractère au minimum et 63 au maximum, et ne peuvent pas être vides. Les valeurs peuvent être vides et comporter 63 caractères au maximum.
- Les clés et les valeurs ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. Tous les caractères doivent être au format d'encodage UTF-8. Les caractères internationaux sont autorisés. Les clés doivent commencer par une lettre minuscule ou un caractère international.
- La partie clé d'un libellé doit être unique au sein d'une ressource spécifique. Cependant, vous pouvez utiliser la même clé avec plusieurs ressources.
Ces limites s'appliquent à la clé et à la valeur de chaque libellé, ainsi qu'aux ressources Google Cloud individuelles associées à des libellés. Vous pouvez appliquer autant de libellés que vous le souhaitez à toutes les ressources d'un projet.
Cas d'utilisation courants des libellés
Voici quelques cas d'utilisation courants des étiquettes :
Libellés d'équipe ou de centre de coût : ajoutez des libellés basés sur l'équipe ou le centre de coûts pour distinguer les clés Cloud KMS appartenant à différentes équipes (par exemple,
team:research
etteam:analytics
). Vous pouvez utiliser ce type de libellé pour la comptabilité analytique ou la budgétisation.Libellés de composant : par exemple,
component:redis
,component:frontend
,component:ingest
etcomponent:dashboard
.Libellés d'environnement ou d'étape : par exemple,
environment:production
etenvironment:test
.Libellés d'état : par exemple,
state:active
,state:readytodelete
etstate:archive
.Libellés de propriété : permettent d'identifier les équipes responsables des opérations (par exemple,
team:shopping-cart
).
Nous vous déconseillons de créer de grands nombres d'étiquettes uniques (par exemple, pour les horodatages ou les valeurs individuelles pour chaque appel d'API). Le problème avec cette approche est que lorsque les valeurs changent fréquemment ou que des clés encombrent le catalogue, il est difficile de filtrer efficacement les ressources et de créer des rapports associés.
Libellés et tags
Pour les ressources, les libellés peuvent être utilisés comme des annotations qu'il est possible d'interroger. Cependant, ils ne peuvent pas être utilisés pour définir des conditions dans le cadre de vos stratégies. Les tags permettent d'autoriser ou de refuser des règles de manière conditionnelle selon qu'une ressource possède un tag spécifique ou non, grâce à un contrôle ultraprécis sur les règles. Pour en savoir plus, consultez la présentation des tags.
Créer une clé avec des libellés
Lors de la création d'une clé, vous pouvez ajouter des libellés en définissant une ou plusieurs paires clé/valeur en tant que libellés.
Console
Dans la console Google Cloud, accédez à la page Gestion des clés.
Cliquez sur le nom du trousseau de clés pour lequel vous souhaitez créer une clé.
Cliquez sur Créer une clé.
Dans Nom de la clé, saisissez un nom pour la clé.
Configurez la clé en fonction de vos besoins.
Cliquez sur Paramètres supplémentaires.
Pour chaque libellé que vous souhaitez ajouter, cliquez sur Ajouter un libellé, puis saisissez la clé et la valeur.
Cliquez sur Créer.
gcloud
Pour utiliser Cloud KMS sur la ligne de commande, commencez par installer ou mettre à jour la dernière version de Google Cloud CLI.
Cet exemple montre comment créer une clé et lui attribuer des libellés. Vous pouvez également ajouter des libellés à une clé existante.
gcloud kms keys create KEY_NAME \ --keyring KEY_RING \ --location LOCATION \ --purpose PURPOSE \ --labels "LABEL_LIST"
Remplacez les éléments suivants :
KEY_NAME
: nom de la clé.KEY_RING
: trousseau de clés dans lequel vous souhaitez créer la clé.LOCATION
: emplacement du trousseau de clés (par exemple,global
).PURPOSE
: l'objectif de la clé (par exemple,encryption
).LABEL_LIST
: liste de paires clé-valeur séparées par une virgule, où chaque paire est au formatLABEL_KEY=LABEL_VALUE
. Exemple :env=prod,team=research
. Chaque clé de libellé ne peut être utilisée qu'une seule fois sur une clé Cloud Key Management Service. Si une clé d'étiquette est spécifiée plusieurs fois avec des valeurs différentes, chaque nouvelle valeur remplace la valeur précédente.
Pour en savoir plus sur toutes les options et valeurs possibles, exécutez la commande avec l'option --help
.
C#
Pour exécuter ce code, commencez par configurer un environnement de développement C#, puis installez le SDK Cloud KMS pour C#.
Go
Pour exécuter ce code, commencez par configurer un environnement de développement Go, puis installez le SDK Cloud KMS pour Go.
Java
Pour exécuter ce code, commencez par configurer un environnement de développement Java et installez le SDK Cloud KMS pour Java.
Node.js
Pour exécuter ce code, commencez par configurer un environnement de développement Node.js, puis installez le SDK Cloud KMS pour Node.js.
PHP
Pour exécuter ce code, commencez par en apprendre plus sur l'utilisation de PHP sur Google Cloud, puis installez le SDK Cloud KMS pour PHP.
Python
Pour exécuter ce code, commencez par configurer un environnement de développement Python, puis installez le SDK Cloud KMS pour Python.
Ruby
Pour exécuter ce code, commencez par configurer un environnement de développement Ruby, puis installez le SDK Cloud KMS pour Ruby.
API
Ajoutez des libellés lorsque vous créez une clé à l'aide de la méthode CryptoKeys.create
et incluez la propriété labels
dans le corps de votre requête. Exemple :
{
"purpose": "ENCRYPT_DECRYPT",
"labels": [
{
"key": "LABEL_KEY",
"value": "LABEL_VALUE"
}
]
}
Remplacez les éléments suivants :
LABEL_KEY
: clé du libellé (par exemple,env
).LABEL_VALUE
: valeur du libellé (par exemple,prod
).
Vous pouvez ajouter plusieurs clés de libellé, chacune avec sa propre valeur. Chaque clé de libellé ne peut être utilisée qu'une seule fois sur une clé Cloud Key Management Service. Si une clé d'étiquette est spécifiée plusieurs fois avec des valeurs différentes, chaque nouvelle valeur remplace la valeur précédente.
Afficher les libellés d'une clé
Console
Dans la console Google Cloud, accédez à la page Gestion des clés.
Cliquez sur le nom du trousseau de clés pour la clé que vous souhaitez inspecter.
Dans l'en-tête, cliquez sur Afficher le panneau d'informations.
Dans le panneau, sélectionnez l'onglet Libellés.
gcloud
Pour utiliser Cloud KMS sur la ligne de commande, commencez par installer ou mettre à jour la dernière version de Google Cloud CLI.
gcloud kms keys describe KEY_NAME \ --keyring KEY_RING \ --location LOCATION
Remplacez les éléments suivants :
KEY_NAME
: nom de la clé pour laquelle vous souhaitez afficher les libellés.KEY_RING
: nom du trousseau de clés qui inclut la cléLOCATION
: emplacement du trousseau de clés.
Pour en savoir plus sur toutes les options et valeurs possibles, exécutez la commande avec l'option --help
.
C#
Pour exécuter ce code, commencez par configurer un environnement de développement C#, puis installez le SDK Cloud KMS pour C#.
Go
Pour exécuter ce code, commencez par configurer un environnement de développement Go, puis installez le SDK Cloud KMS pour Go.
Java
Pour exécuter ce code, commencez par configurer un environnement de développement Java et installez le SDK Cloud KMS pour Java.
Node.js
Pour exécuter ce code, commencez par configurer un environnement de développement Node.js, puis installez le SDK Cloud KMS pour Node.js.
PHP
Pour exécuter ce code, commencez par en apprendre plus sur l'utilisation de PHP sur Google Cloud, puis installez le SDK Cloud KMS pour PHP.
Python
Pour exécuter ce code, commencez par configurer un environnement de développement Python, puis installez le SDK Cloud KMS pour Python.
Ruby
Pour exécuter ce code, commencez par configurer un environnement de développement Ruby, puis installez le SDK Cloud KMS pour Ruby.
API
Ces exemples utilisent curl comme client HTTP pour démontrer l'utilisation de l'API. Pour en savoir plus sur le contrôle des accès, consultez la page Accéder à l'API Cloud KMS.
Pour afficher les libellés appliqués à la clé, utilisez la méthode CryptoKeys.get
:
curl "https://cloudkms.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME" \ --request "GET" \ --header "authorization: Bearer TOKEN" \ --header "content-type: application/json" \ --header "x-goog-user-project: PROJECT_ID"
Remplacez les éléments suivants :
PROJECT_ID
: ID du projet contenant le trousseau de clés.KEY_NAME
: nom de la clé pour laquelle vous souhaitez afficher les libellés.KEY_RING
: nom du trousseau de clés qui inclut la cléLOCATION
: emplacement du trousseau de clés.
Ajouter ou mettre à jour des libellés
Console
Dans la console Google Cloud, accédez à la page Gestion des clés.
Cliquez sur le nom du trousseau de clés pour la clé que vous souhaitez inspecter.
Dans l'en-tête, cliquez sur Afficher le panneau d'informations.
Dans le panneau, sélectionnez l'onglet Libellés.
Modifiez la valeur d'un libellé directement dans le champ de texte correspondant.
Modifiez la clé d'un libellé en ajoutant un nouveau libellé avec le nom de clé souhaité et supprimez l'ancien libellé en cliquant sur Supprimer
, situé à côté du libellé à supprimer.Cliquez sur Enregistrer.
gcloud
Pour utiliser Cloud KMS sur la ligne de commande, commencez par installer ou mettre à jour la dernière version de Google Cloud CLI.
gcloud kms keys update KEY_NAME \ --keyring KEY_RING \ --location LOCATION \ --update-labels "LABEL_LIST"
KEY_NAME
: nom de la clé.KEY_RING
: trousseau de clés qui inclut la clé.LOCATION
: emplacement du trousseau de clés.LABEL_LIST
: liste de paires clé-valeur séparées par une virgule, où chaque paire est au formatLABEL_KEY=LABEL_VALUE
. Exemple :env=prod,team=research
. Chaque clé de libellé ne peut être utilisée qu'une seule fois sur une clé Cloud Key Management Service. Si une clé d'étiquette est spécifiée plusieurs fois avec des valeurs différentes, chaque nouvelle valeur remplace la valeur précédente.
Pour en savoir plus sur toutes les options et valeurs possibles, exécutez la commande avec l'option --help
.
C#
Pour exécuter ce code, commencez par configurer un environnement de développement C#, puis installez le SDK Cloud KMS pour C#.
Go
Pour exécuter ce code, commencez par configurer un environnement de développement Go, puis installez le SDK Cloud KMS pour Go.
Java
Pour exécuter ce code, commencez par configurer un environnement de développement Java et installez le SDK Cloud KMS pour Java.
Node.js
Pour exécuter ce code, commencez par configurer un environnement de développement Node.js, puis installez le SDK Cloud KMS pour Node.js.
PHP
Pour exécuter ce code, commencez par en apprendre plus sur l'utilisation de PHP sur Google Cloud, puis installez le SDK Cloud KMS pour PHP.
Ruby
Pour exécuter ce code, commencez par configurer un environnement de développement Ruby, puis installez le SDK Cloud KMS pour Ruby.
Python
Pour exécuter ce code, commencez par configurer un environnement de développement Python, puis installez le SDK Cloud KMS pour Python.
API
Ces exemples utilisent curl comme client HTTP pour démontrer l'utilisation de l'API. Pour en savoir plus sur le contrôle des accès, consultez la page Accéder à l'API Cloud KMS.
Pour ajouter ou mettre à jour des libellés associés à une clé existante, utilisez la méthode CryptoKeys.patch et ajoutez la propriété labels
dans le corps de votre requête. Exemple :
{
"labels": [
{
"key": "LABEL_KEY",
"value": "LABEL_VALUE"
}
]
}
Supprimer des libellés
Console
Dans la console Google Cloud, accédez à la page Gestion des clés.
Cliquez sur le nom du trousseau de clés pour la clé que vous souhaitez inspecter.
Dans l'en-tête, cliquez sur Afficher le panneau d'informations.
Dans le panneau, sélectionnez l'onglet Libellés.
Cliquez sur l'icône Supprimer
située à côté des libellés que vous souhaitez supprimer.Cliquez sur Enregistrer.
gcloud
Pour utiliser Cloud KMS sur la ligne de commande, commencez par installer ou mettre à jour la dernière version de Google Cloud CLI.
gcloud kms keys update KEY_NAME \ --keyring KEY_RING \ --location LOCATION \ --remove-labels "LABEL_KEYS"
KEY_NAME
: nom de la clé.KEY_RING
: trousseau de clés qui inclut la clé.LOCATION
: emplacement du trousseau de clés.LABEL_LIST
: liste de clés d'étiquettes séparées par des virgules que vous souhaitez supprimer de la clé (par exemple,env,team
).
Pour en savoir plus sur toutes les options et valeurs possibles, exécutez la commande avec l'option --help
.
C#
Pour exécuter ce code, commencez par configurer un environnement de développement C#, puis installez le SDK Cloud KMS pour C#.
Go
Pour exécuter ce code, commencez par configurer un environnement de développement Go, puis installez le SDK Cloud KMS pour Go.
Java
Pour exécuter ce code, commencez par configurer un environnement de développement Java et installez le SDK Cloud KMS pour Java.
Node.js
Pour exécuter ce code, commencez par configurer un environnement de développement Node.js, puis installez le SDK Cloud KMS pour Node.js.
PHP
Pour exécuter ce code, commencez par en apprendre plus sur l'utilisation de PHP sur Google Cloud, puis installez le SDK Cloud KMS pour PHP.
Python
Pour exécuter ce code, commencez par configurer un environnement de développement Python, puis installez le SDK Cloud KMS pour Python.
Ruby
Pour exécuter ce code, commencez par configurer un environnement de développement Ruby, puis installez le SDK Cloud KMS pour Ruby.
API
Ces exemples utilisent curl comme client HTTP pour démontrer l'utilisation de l'API. Pour en savoir plus sur le contrôle des accès, consultez la page Accéder à l'API Cloud KMS.
Pour supprimer des libellés associés à une clé existante, utilisez la méthode CryptoKeys.patch et incluez la propriété labels
en tant que tableau vide dans le corps de la requête. Exemple :
{
"labels": []
}
Journaux d'audit
Cloud Audit Logging pour Cloud KMS peut être utilisé pour consigner des informations sur les libellés lors de la création ou la mise à jour de clés, qui sont des activités d'administration. Les modifications apportées aux libellés sont consignées dans le journal d'activité d'administration.