Cloud Key Management Service proporciona la opción de agregar etiquetas a tus claves de Cloud KMS. Las etiquetas son pares clave-valor que puedes usar para agrupar claves de Cloud KMS relacionadas y almacenar metadatos sobre una clave de Cloud KMS.
Las etiquetas se incluyen en tu factura, lo que te permite ver cómo se distribuyen los costos entre tus etiquetas.
Puedes agregar, actualizar y quitar etiquetas de claves con Google Cloud CLI y la API de REST de Cloud KMS.
Puedes usar etiquetas con otros recursos de Google Cloud, como los recursos de máquinas virtuales y los buckets de almacenamiento. Para obtener más información sobre cómo usar las etiquetas en Google Cloud, consulta Cómo crear y administrar etiquetas.
¿Qué son las etiquetas?
Una etiqueta es un par clave-valor que puedes asignar a las claves de Cloud KMS de Google Cloud. Te ayudan a organizar estos recursos y administrar los costos a gran escala, con el nivel de detalle que necesitas. Puedes adjuntar una etiqueta a cada recurso y, luego, usarlas para filtrarlos. La información sobre las etiquetas se envía al sistema de facturación que te permite desglosar los cargos facturados por etiqueta. Con los informes de facturación integrados, puedes filtrar y agrupar costos por etiquetas de recurso. También puedes usar etiquetas para consultar las exportaciones de datos de facturación.
Requisitos para las etiquetas
Las etiquetas que se aplican a un recurso deben cumplir los siguientes requisitos:
- Cada recurso puede tener hasta 64 etiquetas de clúster.
- Cada etiqueta debe ser un par clave-valor.
- La longitud de las claves debe ser de entre 1 y 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y su longitud máxima es de 63 caracteres.
- Las claves y los valores pueden contener solo letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8, además, se permiten los caracteres internacionales. Las claves deben comenzar con una letra en minúscula o un carácter internacional.
- La porción de clave de una etiqueta debe ser única para un solo recurso. Sin embargo, puedes usar la misma clave en varios recursos.
Estos límites se aplican a la clave y al valor de cada etiqueta de clúster, y a los recursos individuales de Google Cloud que tienen etiquetas de clúster. No hay límite para la cantidad de etiquetas de clúster que puedes aplicar en todos los recursos de un proyecto.
Usos comunes de las etiquetas
Estos son algunos casos prácticos comunes de las etiquetas:
Etiquetas de equipo o centro de costos: agrega etiquetas según el equipo o centro de costos para distinguir las claves de Cloud KMS que pertenecen a equipos diferentes (por ejemplo,
team:research
yteam:analytics
). Puedes usar este tipo de etiquetas para la contabilidad de costos o la creación de presupuestos.Etiquetas de componentes: por ejemplo,
component:redis
,component:frontend
,component:ingest
ycomponent:dashboard
.Etiquetas de entorno o etapa: por ejemplo,
environment:production
yenvironment:test
.Etiquetas de estado: por ejemplo,
state:active
,state:readytodelete
ystate:archive
.Etiquetas de propiedad: Se usan para identificar a los equipos responsables de las operaciones, por ejemplo:
team:shopping-cart
.
No recomendamos crear grandes cantidades de etiquetas únicas, como marcas de tiempo o valores individuales para cada llamada a la API. El problema con este enfoque es que, cuando los valores cambian con frecuencia o con claves que sobrecargan el catálogo, esto dificulta el filtrado y la generación de informes eficaces para los recursos.
Etiquetas
Las etiquetas se pueden usar como anotaciones que se pueden consultar en los recursos, pero no se pueden usar para establecer condiciones en las políticas. Las etiquetas proporcionan una forma de permitir o rechazar políticas de manera condicional en función de si un recurso tiene una etiqueta específica, ya que proporciona un control detallado sobre las políticas. Para obtener más información, consulta la Descripción general de etiquetas.
Cómo crear una clave con etiquetas
Para agregar etiquetas cuando crees una clave, debes proporcionar uno o más pares clave-valor durante la operación de creación.
Console
En la consola de Google Cloud, ve a la página Administración de claves.
Haz clic en el nombre del llavero de claves para el que deseas crear una clave.
Haz clic en Crear clave.
En Nombre de la clave, ingresa un nombre para la clave.
Configura la clave según tus necesidades.
Haz clic en Configuración adicional.
Para cada etiqueta que desees agregar, haz clic en Agregar etiqueta y, luego, ingresa la Clave y el Valor.
Haz clic en Crear.
gcloud
Para usar Cloud KMS en la línea de comandos, primero instala o actualiza a la versión más reciente de Google Cloud CLI.
En este ejemplo, se muestra cómo crear una clave nueva y asignarle etiquetas. También puedes agregar etiquetas a una clave existente.
gcloud kms keys create KEY_NAME \ --keyring KEY_RING \ --location LOCATION \ --purpose PURPOSE \ --labels "LABEL_LIST"
Reemplaza lo siguiente:
KEY_NAME
: el nombre de la clave.KEY_RING
: Es el llavero de claves en el que deseas crear la clave.LOCATION
: Es la ubicación del llavero de claves, por ejemplo,global
.PURPOSE
: El propósito de la clave, por ejemplo,encryption
.LABEL_LIST
: Es una lista separada por comas de pares clave-valor, en la que cada par tiene el formatoLABEL_KEY=LABEL_VALUE
. Por ejemplo,env=prod,team=research
. Cada clave de etiqueta solo se puede usar una vez en una clave de Cloud Key Management Service. Si se especifica una clave de etiqueta varias veces con valores diferentes, cada valor nuevo reemplaza al anterior.
Para obtener información sobre todas las marcas y los valores posibles, ejecuta el comando con la marca --help
.
C#
Para ejecutar este código, primero configura un entorno de desarrollo de C# e instala el SDK de C# para Cloud KMS.
Go
Para ejecutar este código, primero configura un entorno de desarrollo de Go y, luego, instala el SDK de Go para Cloud KMS.
Java
Para ejecutar este código, primero configura un entorno de desarrollo de Java y, luego, instala el SDK de Java para Cloud KMS.
Node.js
Para ejecutar este código, primero configura un entorno de desarrollo de Node.js y, luego, instala el SDK de Node.js para Cloud KMS.
PHP
Para ejecutar este código, primero obtén información sobre cómo usar PHP en Google Cloud y, luego, instala el SDK de PHP para Cloud KMS.
Python
Para ejecutar este código, primero configura un entorno de desarrollo de Python y, luego, instala el SDK de Python para Cloud KMS.
Ruby
Para ejecutar este código, primero configura un entorno de desarrollo de Ruby y, luego, instala el SDK de Ruby para Cloud KMS.
API
Para agregar etiquetas cuando crees una clave nueva, usa el método CryptoKeys.create
y agrega la propiedad labels
al cuerpo de tu solicitud. Por ejemplo:
{
"purpose": "ENCRYPT_DECRYPT",
"labels": [
{
"key": "LABEL_KEY",
"value": "LABEL_VALUE"
}
]
}
Reemplaza lo siguiente:
LABEL_KEY
: La clave de la etiqueta, por ejemplo,env
.LABEL_VALUE
: Es el valor de la etiqueta, por ejemplo,prod
.
Puedes agregar varias claves de etiqueta, cada una con su propio valor. Cada clave de etiqueta solo se puede usar una vez en una clave de Cloud Key Management Service. Si se especifica una clave de etiqueta varias veces con valores diferentes, cada valor nuevo reemplaza al anterior.
Cómo ver las etiquetas de una clave
Console
En la consola de Google Cloud, ve a la página Administración de claves.
Haz clic en el nombre del llavero de claves de la clave que quieres inspeccionar.
En el encabezado, haz clic en Mostrar panel de información.
En el panel, elige la pestaña Etiquetas.
gcloud
Para usar Cloud KMS en la línea de comandos, primero instala o actualiza a la versión más reciente de Google Cloud CLI.
gcloud kms keys describe KEY_NAME \ --keyring KEY_RING \ --location LOCATION
Reemplaza lo siguiente:
KEY_NAME
: Es el nombre de la clave para la que deseas ver las etiquetas.KEY_RING
: Es el nombre del llavero de claves que contiene la clave.LOCATION
: Es la ubicación del llavero de claves.
Para obtener información sobre todas las marcas y los valores posibles, ejecuta el comando con la marca --help
.
C#
Para ejecutar este código, primero configura un entorno de desarrollo de C# e instala el SDK de C# para Cloud KMS.
Go
Para ejecutar este código, primero configura un entorno de desarrollo de Go y, luego, instala el SDK de Go para Cloud KMS.
Java
Para ejecutar este código, primero configura un entorno de desarrollo de Java y, luego, instala el SDK de Java para Cloud KMS.
Node.js
Para ejecutar este código, primero configura un entorno de desarrollo de Node.js y, luego, instala el SDK de Node.js para Cloud KMS.
PHP
Para ejecutar este código, primero obtén información sobre cómo usar PHP en Google Cloud y, luego, instala el SDK de PHP para Cloud KMS.
Python
Para ejecutar este código, primero configura un entorno de desarrollo de Python y, luego, instala el SDK de Python para Cloud KMS.
Ruby
Para ejecutar este código, primero configura un entorno de desarrollo de Ruby y, luego, instala el SDK de Ruby para Cloud KMS.
API
En estos ejemplos, se usa curl como un cliente HTTP para demostrar el uso de la API. Para obtener más información sobre el control de acceso, consulta Accede a la API de Cloud KMS.
Para ver las etiquetas que se aplicaron a una clave, usa el método 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"
Reemplaza lo siguiente:
PROJECT_ID
: El ID del proyecto que contiene el llavero.KEY_NAME
: Es el nombre de la clave para la que deseas ver las etiquetas.KEY_RING
: Es el nombre del llavero de claves que contiene la clave.LOCATION
: Es la ubicación del llavero de claves.
Agregar o actualizar etiquetas
Console
En la consola de Google Cloud, ve a la página Administración de claves.
Haz clic en el nombre del llavero de claves de la clave que quieres inspeccionar.
En el encabezado, haz clic en Mostrar panel de información.
En el panel, elige la pestaña Etiquetas.
Edita el valor de una etiqueta directamente en el campo de texto correspondiente.
Para editar la clave de una etiqueta, agrega una nueva etiqueta con el nombre de clave deseado y borra la etiqueta anterior haciendo clic en Borrar
junto a la etiqueta que deseas borrar.Haz clic en Guardar.
gcloud
Para usar Cloud KMS en la línea de comandos, primero instala o actualiza a la versión más reciente de Google Cloud CLI.
gcloud kms keys update KEY_NAME \ --keyring KEY_RING \ --location LOCATION \ --update-labels "LABEL_LIST"
KEY_NAME
: el nombre de la clave.KEY_RING
: Es el llavero de claves que contiene la clave.LOCATION
: Es la ubicación del llavero de claves.LABEL_LIST
: Es una lista separada por comas de pares clave-valor, en la que cada par tiene el formatoLABEL_KEY=LABEL_VALUE
. Por ejemplo,env=prod,team=research
. Cada clave de etiqueta solo se puede usar una vez en una clave de Cloud Key Management Service. Si se especifica una clave de etiqueta varias veces con valores diferentes, cada valor nuevo reemplaza al anterior.
Para obtener información sobre todas las marcas y los valores posibles, ejecuta el comando con la marca --help
.
C#
Para ejecutar este código, primero configura un entorno de desarrollo de C# e instala el SDK de C# para Cloud KMS.
Go
Para ejecutar este código, primero configura un entorno de desarrollo de Go y, luego, instala el SDK de Go para Cloud KMS.
Java
Para ejecutar este código, primero configura un entorno de desarrollo de Java y, luego, instala el SDK de Java para Cloud KMS.
Node.js
Para ejecutar este código, primero configura un entorno de desarrollo de Node.js y, luego, instala el SDK de Node.js para Cloud KMS.
PHP
Para ejecutar este código, primero obtén información sobre cómo usar PHP en Google Cloud y, luego, instala el SDK de PHP para Cloud KMS.
Ruby
Para ejecutar este código, primero configura un entorno de desarrollo de Ruby y, luego, instala el SDK de Ruby para Cloud KMS.
Python
Para ejecutar este código, primero configura un entorno de desarrollo de Python y, luego, instala el SDK de Python para Cloud KMS.
API
En estos ejemplos, se usa curl como un cliente HTTP para demostrar el uso de la API. Para obtener más información sobre el control de acceso, consulta Accede a la API de Cloud KMS.
Para agregar o actualizar etiquetas de una clave existente, usa el método CryptoKeys.patch y agrega la propiedad labels
al cuerpo de tu solicitud. Por ejemplo:
{
"labels": [
{
"key": "LABEL_KEY",
"value": "LABEL_VALUE"
}
]
}
Instrucciones para quitar las etiquetas
Console
En la consola de Google Cloud, ve a la página Administración de claves.
Haz clic en el nombre del llavero de claves de la clave que quieres inspeccionar.
En el encabezado, haz clic en Mostrar panel de información.
En el panel, elige la pestaña Etiquetas.
Haz clic en el ícono Borrar
junto a las etiquetas que deseas borrar.Haz clic en Guardar.
gcloud
Para usar Cloud KMS en la línea de comandos, primero instala o actualiza a la versión más reciente de Google Cloud CLI.
gcloud kms keys update KEY_NAME \ --keyring KEY_RING \ --location LOCATION \ --remove-labels "LABEL_KEYS"
KEY_NAME
: el nombre de la clave.KEY_RING
: Es el llavero de claves que contiene la clave.LOCATION
: Es la ubicación del llavero de claves.LABEL_LIST
: Es una lista de claves de etiqueta separadas por comas que deseas quitar de la clave, por ejemplo,env,team
.
Para obtener información sobre todas las marcas y los valores posibles, ejecuta el comando con la marca --help
.
C#
Para ejecutar este código, primero configura un entorno de desarrollo de C# e instala el SDK de C# para Cloud KMS.
Go
Para ejecutar este código, primero configura un entorno de desarrollo de Go y, luego, instala el SDK de Go para Cloud KMS.
Java
Para ejecutar este código, primero configura un entorno de desarrollo de Java y, luego, instala el SDK de Java para Cloud KMS.
Node.js
Para ejecutar este código, primero configura un entorno de desarrollo de Node.js y, luego, instala el SDK de Node.js para Cloud KMS.
PHP
Para ejecutar este código, primero obtén información sobre cómo usar PHP en Google Cloud y, luego, instala el SDK de PHP para Cloud KMS.
Python
Para ejecutar este código, primero configura un entorno de desarrollo de Python y, luego, instala el SDK de Python para Cloud KMS.
Ruby
Para ejecutar este código, primero configura un entorno de desarrollo de Ruby y, luego, instala el SDK de Ruby para Cloud KMS.
API
En estos ejemplos, se usa curl como un cliente HTTP para demostrar el uso de la API. Para obtener más información sobre el control de acceso, consulta Accede a la API de Cloud KMS.
Para quitar etiquetas de una clave existente, usa el método CryptoKeys.patch y agrega la propiedad labels
como un array vacío en el cuerpo de tu solicitud. Por ejemplo:
{
"labels": []
}
Registro de auditoría
Los registros de auditoría de Cloud para Cloud KMS se pueden usar para registrar información de etiquetas cuando se crean o actualizan las claves. Tanto la creación como la actualización de claves son actividades de administrador, por lo que estos cambios se anotan en el registro de actividades del administrador.