Crear y administrar etiquetas

Puede aplicar etiquetas de usuario a los recursos de clúster y de trabajo de Dataproc para agrupar recursos y operaciones relacionadas para filtrar y generar listas posteriormente. Debes asociar las etiquetas con los recursos cuando se crea el recurso, o el clúster o en cuando se envían los trabajos. Una vez que un recurso se asocia con una etiqueta, la etiqueta se propaga a las operaciones realizadas en el recurso (creación, actualización, actualización para parches o eliminación de clústeres; envío, actualización, cancelación o eliminación de trabajos), lo que te permite filtrar y crear listas de clústeres, trabajos y operaciones por etiqueta.

También puedes agregar etiquetas a los recursos de Compute Engine asociados con los recursos del clúster, como las instancias de máquina virtual y los discos.

¿Qué son las etiquetas?

Una etiqueta es un par clave-valor que te ayuda a organizar los clústeres y trabajos de Google Cloud Dataproc. Puedes adjuntar una etiqueta a cada recurso y, luego, usarlas para filtrarlos. La información sobre las etiquetas se reenvía al sistema de facturación a fin de que puedas desglosar tus cargos de facturación según las etiquetas.

Usos comunes de las etiquetas

No recomendamos crear grandes cantidades de etiquetas únicas, como marcas de tiempo o valores individuales para cada llamada a la API. Estos son algunos casos prácticos comunes de las etiquetas:

  • Etiquetas del equipo o del centro de costos: Agregue etiquetas según el equipo o centro de costos para distinguir los clústeres de Dataproc y los trabajos que pertenecen a distintos equipos (por ejemplo, team:research y team:analytics). Puede usar este tipo de etiqueta para la contabilidad de costos o la creación del presupuesto.

  • Etiquetas de componentes: por ejemplo, component:redis, component:frontend, component:ingest y component:dashboard.

  • Etiquetas de entorno o etapa: por ejemplo, environment:production y environment:test.

  • Etiquetas de estado: por ejemplo, state:active, state:readytodelete y state:archive.

Requisitos para las etiquetas

Las etiquetas que se aplican a un recurso deben cumplir los siguientes requisitos:

  • Cada recurso puede tener varias etiquetas, hasta 64.
  • 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.
  • La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos.
  • Las claves deben comenzar con una letra en minúscula o un carácter internacional.

Crea y usa etiquetas de Dataproc

Comando de gcloud

Puedes especificar una o más etiquetas para que se apliquen a un clúster o trabajo de Dataproc al momento de su creación o envío con la herramienta de línea de comandos de gcloud.

gcloud dataproc clusters create args --labels env=prod,customer=acme
gcloud dataproc jobs submit args --labels env=prod,customer=acme

Una vez que se crea un trabajo o un clúster de Dataproc, puedes actualizar las etiquetas asociadas con ese recurso mediante la herramienta de línea de comandos de gcloud.

gcloud dataproc clusters update args --update-labels env=prod,customer=acme
gcloud dataproc jobs update args --update-labels env=prod,customer=acme

Del mismo modo, puedes usar la herramienta de línea de comandos de gcloud para filtrar los recursos de Dataproc por etiqueta mediante una expresión de filtro con el siguiente formato: labels.<key=value>.

gcloud dataproc clusters list \
    --region=region \
    --filter="status.state=ACTIVE AND labels.env=prod"
gcloud dataproc jobs list \
    --region=region \
    --filter="status.state=ACTIVE AND labels.customer=acme"

Consulta la documentación de las API de clusters.list y jobs.list de Dataproc para obtener más información sobre cómo escribir una expresión de filtro.

API de REST

Las etiquetas se pueden adjuntar a los recursos de Dataproc a través de la API de REST de Dataproc. Las API de clusters.create y jobs.submit pueden usarse para adjuntar etiquetas a un clúster o trabajo al momento de su creación o envío. Las API de clusters.patch y jobs.patch pueden usarse para editar etiquetas luego de que se creó el recurso. A continuación, se muestra el cuerpo JSON de una solicitud cluster.create que adjunta una etiqueta key1:value al clúster.

{
  "clusterName":"cluster-1",
  "projectId":"my-project",
  "config":{
    "configBucket":"",
    "gceClusterConfig":{
      "networkUri":".../networks/default",
      "zoneUri":".../zones/us-central1-f"
    },
    "masterConfig":{
      "numInstances":1,
      "machineTypeUri":"..../machineTypes/n1-standard-4",
      "diskConfig":{
        "bootDiskSizeGb":500,
        "numLocalSsds":0
      }
    },
    "workerConfig":{
      "numInstances":2,
      "machineTypeUri":"...machineTypes/n1-standard-4",
      "diskConfig":{
        "bootDiskSizeGb":500,
        "numLocalSsds":0
      }
    }
  },
  "labels":{
    "key1":"value1"
  }
}

Las API de clusters.list y jobs.list pueden usarse para crear listas de recursos que coinciden con un filtro específico mediante el siguiente formato: labels.<key=value>.

A continuación, se muestra un ejemplo de una solicitud HTTPS GET a la API de clusters.list de Dataproc que especifica un filtro de etiqueta key=value. El emisor inserta project, region, un filtro label-key y label-value, y api-key. Ten en cuenta que esta solicitud de ejemplo está dividida en dos líneas para que se pueda leer con mayor facilidad.

GET https://dataproc.googleapis.com/v1/projects/project/regions/region/clusters?
filter=labels.label-key=label-value&key=api-key

Consulta la documentación de las API de clusters.list y jobs.list de Dataproc para obtener más información sobre cómo escribir una expresión de filtro.

Console

Puedes especificar un conjunto de etiquetas para agregar a un recurso de Dataproc durante la creación o envío de Cloud Console.

  • Agrega etiquetas a un clúster desde la sección Etiquetas del panel Personalizar clúster de la página Crear un clúster.
  • Agrega etiquetas a un trabajo desde la página de Enviar un trabajo de Dataproc.

Una vez que se crea un recurso de Dataproc, puedes actualizar las etiquetas asociadas con él. Para actualizar las etiquetas, primero debes hacer clic en SHOW INFO PANEL en la esquina superior izquierda de la página. Este es un ejemplo de la página Dataproc→List clusters (Mostrar lista de clústeres).

Una vez que se muestra el panel de información, puedes actualizar las etiquetas de tus recursos de Dataproc. A continuación, se muestra un ejemplo de la actualización de etiquetas para un clúster de Dataproc.

También es posible actualizar etiquetas para múltiples elementos en una operación. En este ejemplo, las etiquetas se actualizan para múltiples trabajos de Dataproc al mismo tiempo.

Las etiquetas te permiten filtrar los recursos de Dataproc que se muestran en las páginas Dataproc→Lista de clústeres y Dataproc→Lista de trabajos. En la parte superior de la página, puede usar los labels.<labelname>=<value> del patrón de búsqueda para filtrar los recursos por etiqueta.

Etiquetas aplicadas de manera automática

Cuando creas o actualizas un clúster, Dataproc aplica de forma automática varias etiquetas al clúster y a sus recursos. Por ejemplo, Dataproc aplica etiquetas a máquinas virtuales, discos persistentes y aceleradores cuando se crea un clúster. Las etiquetas aplicadas de forma automática tienen un prefijo goog-dataproc especial.

Las siguientes etiquetas goog-dataproc se aplican de forma automática a los recursos de Dataproc. Todos los valores que proporciones para las etiquetas goog-dataproc reservadas en la creación del clúster anularán los valores proporcionados de forma automática. Por esta razón, no se recomienda que proporciones tus propios valores para estas etiquetas.

Etiqueta Descripción
goog-dataproc-cluster-name Nombre del clúster especificado por el usuario.
goog-dataproc-cluster-uuid ID de clúster único.
goog-dataproc-location Extremo regional de clúster de Dataproc

Puedes usar estas etiquetas aplicadas automáticamente de muchas maneras, incluidas las siguientes:

Qué sigue