En este documento, se explica cómo usar etiquetas para organizar tus recursos de Batch.
Las etiquetas son pares clave-valor que se aplican a los recursos para agruparlos y describirlos. Batch tiene etiquetas predefinidas, que se aplican automáticamente a los recursos, y etiquetas personalizadas, que puedes definir y aplicar cuando creas un trabajo.
Las etiquetas te permiten filtrar los resultados de las listas de recursos y los informes de Facturación de Cloud. Por ejemplo, puedes usar etiquetas para hacer lo siguiente:
Aclara y organiza la lista de trabajos de tu proyecto.
Distingue los ejecutables de un trabajo usando etiquetas para describir el tipo de contenedor o secuencia de comandos que especifican.
Analiza los costos filtrando los informes de Facturación de Cloud para los recursos creados por Batch o trabajos específicos.
Para obtener más información sobre las etiquetas, consulta la documentación de Compute Engine sobre etiquetas.
Antes de comenzar
- Si nunca usaste Batch, revisa Cómo comenzar a usar Batch y habilita Batch completando los requisitos previos para proyectos y usuarios.
-
Para obtener los permisos que necesitas para crear un trabajo, pídele a tu administrador que te otorgue los siguientes roles de IAM:
-
Editor de trabajos por lotes (
roles/batch.jobsEditor
) en el proyecto -
Usuario de cuenta de servicio (
roles/iam.serviceAccountUser
) en la cuenta de servicio del trabajo, que, de forma predeterminada, es la cuenta de servicio predeterminada de Compute Engine
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.
-
Editor de trabajos por lotes (
Restricciones
Además de los requisitos para las etiquetas especificados en la documentación de Compute Engine, aplicar etiquetas a un trabajo de Batch y a sus recursos tiene las siguientes restricciones:
El procesamiento por lotes solo admite etiquetas para los recursos que se crean con el procesamiento por lotes y que son de los siguientes tipos:
Trabajos
Runnables
Unidades de procesamiento gráfico (GPU) para un trabajo (si corresponde)
Discos persistentes (discos de arranque y cualquier volumen de almacenamiento) para un trabajo
Instancias de máquinas virtuales (VM) para un trabajo
Después de tener en cuenta las etiquetas predefinidas que Batch aplica automáticamente a un trabajo, puedes definir las siguientes cantidades de etiquetas personalizadas:
Puedes definir un máximo de 63 etiquetas personalizadas para aplicar al trabajo y a sus ejecutables.
Puedes definir un máximo de 61 etiquetas personalizadas para aplicar a cada GPU, disco persistente y VM creados para el trabajo.
El procesamiento por lotes solo admite la definición de etiquetas personalizadas con nombres únicos. Esto tiene las siguientes consecuencias:
Si intentas anular una etiqueta predefinida, se producirán errores.
Si se define una etiqueta personalizada duplicada, se anula la etiqueta personalizada existente.
Batch solo admite la definición de etiquetas cuando se crea un trabajo.
No se pueden agregar, actualizar ni quitar etiquetas para trabajos y ejecutables.
Si bien es posible usar Compute Engine para agregar, actualizar o quitar etiquetas de los discos persistentes y las VMs creados para los trabajos, no se recomienda hacerlo. No se puede estimar de forma confiable el período durante el que existen los recursos de un trabajo, y es posible que los cambios no funcionen correctamente con Batch.
Para usar etiquetas para filtrar tu lista de trabajos, debes ver tu lista de trabajos con gcloud CLI o la API de Batch.
Etiquetas predefinidas
Cada etiqueta predefinida tiene una clave que comienza con el prefijo batch-
. De forma predeterminada, Batch aplica automáticamente las siguientes etiquetas predefinidas:
Para cada trabajo que crees, haz lo siguiente:
batch-job-id
: El valor de esta etiqueta se establece en el nombre del trabajo.
A cada GPU, disco persistente y VM creados para un trabajo:
batch-job-id
: El valor de esta etiqueta se establece en el nombre del trabajo.batch-job-uid
: El valor de esta etiqueta se establece en el identificador único (UID) del trabajo.batch-node
: El valor de esta etiqueta es nulo. Solo agrupa todas las GPUs, los discos persistentes y las VMs que se crean para los trabajos. Por ejemplo, usa esta etiqueta cuando consultes un informe de facturación de Cloud para identificar los costos de todas las GPUs, los discos persistentes y las VMs creados por Batch.
Define etiquetas personalizadas
De manera opcional, puedes definir una o más etiquetas personalizadas cuando crees un trabajo. Puedes definir etiquetas personalizadas con claves nuevas o con claves que ya usa tu proyecto. Para definir etiquetas personalizadas, selecciona uno o más de los siguientes métodos en este documento según el propósito de la etiqueta:
Define etiquetas personalizadas para el trabajo y sus recursos.
En esta sección, se explica cómo aplicar una o más etiquetas personalizadas al trabajo y a cada GPU, disco persistente y VM creados para el trabajo. Después de crear el trabajo, puedes usar estas etiquetas para filtrar los informes de Facturación de Cloud y las listas de trabajos, discos persistentes y VMs de tu proyecto.
Define etiquetas personalizadas para el trabajo.
En esta sección, se explica cómo aplicar una o más etiquetas personalizadas al trabajo. Después de crear el trabajo, puedes usar estas etiquetas para filtrar las listas de trabajos de tu proyecto.
Define etiquetas personalizadas para los elementos ejecutables.
En esta sección, se explica cómo aplicar una o más etiquetas personalizadas a uno o más objetos ejecutables para el trabajo. Después de crear el trabajo, puedes usar estas etiquetas para filtrar las listas de trabajos de tu proyecto.
Define etiquetas personalizadas para el trabajo y sus recursos
Las etiquetas definidas en el campo labels
de la política de asignación de un trabajo se aplican al trabajo, así como a cada GPU (si hay alguna), disco persistente (todos los discos de arranque y los volúmenes de almacenamiento nuevos) y VM creados para el trabajo.
Puedes definir etiquetas para un trabajo y sus recursos cuando creas un trabajo con gcloud CLI o la API de Batch.
gcloud
Por ejemplo, para crear un trabajo de contenedor básico en us-central1
que defina dos etiquetas personalizadas que se apliquen al trabajo y a los recursos creados para el trabajo, sigue estos pasos:
Crea un archivo JSON que especifique los detalles de configuración del trabajo y el campo
allocationPolicy.labels
.{ "allocationPolicy": { "instances": [ { "policy": { "machineType": "e2-standard-4" } } ], "labels": { "VM_LABEL_NAME1": "VM_LABEL_VALUE1", "VM_LABEL_NAME2": "VM_LABEL_VALUE2" } }, "taskGroups": [ { "taskSpec": { "runnables": [ { "container": { "imageUri": "gcr.io/google-containers/busybox", "entrypoint": "/bin/sh", "commands": [ "-c", "echo Hello world!" ] } } ] } } ] }
Reemplaza lo siguiente:
VM_LABEL_NAME1
: Es el nombre de la primera etiqueta que se aplicará a las VMs creadas para el trabajo.VM_LABEL_VALUE1
: Es el valor de la primera etiqueta que se aplicará a las VMs creadas para el trabajo.VM_LABEL_NAME2
: Es el nombre de la segunda etiqueta que se aplicará a las VMs creadas para el trabajo.VM_LABEL_VALUE2
: Es el valor de la segunda etiqueta que se aplicará a las VMs creadas para el trabajo.
Crea el trabajo en
us-central1
con el comandogcloud batch jobs submit
.gcloud batch jobs submit example-job \ --config=JSON_CONFIGURATION_FILE \ --location=us-central1
Reemplaza
JSON_CONFIGURATION_FILE
por la ruta de acceso al archivo JSON con los detalles de configuración del trabajo que creaste en el paso anterior.
API
Por ejemplo, para crear un trabajo de contenedor básico en us-central1
que defina dos etiquetas personalizadas que se apliquen al trabajo y a los recursos creados para el trabajo, realiza una solicitud POST
al método jobs.create
y especifica el campo allocationPolicy.labels
.
POST https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?job_id=example-job
{
"allocationPolicy": {
"instances": [
{
"policy": {
"machineType": "e2-standard-4"
}
}
],
"labels": {
"VM_LABEL_NAME1": "VM_LABEL_VALUE1",
"VM_LABEL_NAME2": "VM_LABEL_VALUE2"
}
},
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"container": {
"imageUri": "gcr.io/google-containers/busybox",
"entrypoint": "/bin/sh",
"commands": [
"-c",
"echo Hello world!"
]
}
}
]
}
}
]
}
Reemplaza lo siguiente:
VM_LABEL_NAME1
: Es el nombre de la primera etiqueta que se aplicará a las VMs creadas para el trabajo.VM_LABEL_VALUE1
: Es el valor de la primera etiqueta que se aplicará a las VMs creadas para el trabajo.VM_LABEL_NAME2
: Es el nombre de la segunda etiqueta que se aplicará a las VMs creadas para el trabajo.VM_LABEL_VALUE2
: Es el valor de la segunda etiqueta que se aplicará a las VMs creadas para el trabajo.
Java
Node.js
Python
Define etiquetas personalizadas para el trabajo
Las etiquetas definidas en el campo labels
del trabajo solo se aplican al trabajo.
Puedes definir etiquetas para un trabajo cuando lo creas con gcloud CLI o la API de Batch.
gcloud
Por ejemplo, para crear un trabajo de contenedor básico en us-central1
que defina dos etiquetas personalizadas que se apliquen al trabajo en sí, sigue estos pasos:
Crea un archivo JSON que especifique los detalles de configuración del trabajo y el campo
labels
.{ "taskGroups": [ { "taskSpec": { "runnables": [ { "container": { "imageUri": "gcr.io/google-containers/busybox", "entrypoint": "/bin/sh", "commands": [ "-c", "echo Hello World!" ] } } ] } } ], "labels": { "JOB_LABEL_NAME1": "JOB_LABEL_VALUE1", "JOB_LABEL_NAME2": "JOB_LABEL_VALUE2" } }
Reemplaza lo siguiente:
JOB_LABEL_NAME1
: Es el nombre de la primera etiqueta que se aplicará a tu trabajo.JOB_LABEL_VALUE1
: Es el valor de la primera etiqueta que se aplicará a tu trabajo.JOB_LABEL_NAME2
: Es el nombre de la segunda etiqueta que se aplicará a tu trabajo.JOB_LABEL_VALUE2
: Es el valor de la segunda etiqueta que se aplicará a tu trabajo.
Crea el trabajo en
us-central1
con el comandogcloud batch jobs submit
y las siguientes marcas:gcloud batch jobs submit example-job \ --config=JSON_CONFIGURATION_FILE \ --location=us-central1
Reemplaza
JSON_CONFIGURATION_FILE
por la ruta de acceso al archivo JSON con los detalles de configuración del trabajo que creaste en el paso anterior.
API
Por ejemplo, para crear un trabajo de contenedor en us-central1
que defina dos etiquetas personalizadas para aplicar a los trabajos, realiza una solicitud POST
al método jobs.create
y especifica el campo labels
.
POST https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?job_id=example-job
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"container": {
"imageUri": "gcr.io/google-containers/busybox",
"entrypoint": "/bin/sh",
"commands": [
"-c",
"echo Hello World!"
]
}
}
]
}
}
],
"labels": {
"JOB_LABEL_NAME1": "JOB_LABEL_VALUE1",
"JOB_LABEL_NAME2": "JOB_LABEL_VALUE2"
}
}
Reemplaza lo siguiente:
JOB_LABEL_NAME1
: Es el nombre de la primera etiqueta que se aplicará a tu trabajo.JOB_LABEL_VALUE1
: Es el valor de la primera etiqueta que se aplicará a tu trabajo.JOB_LABEL_NAME2
: Es el nombre de la segunda etiqueta que se aplicará a tu trabajo.JOB_LABEL_VALUE2
: Es el valor de la segunda etiqueta que se aplicará a tu trabajo.
Java
Node.js
Python
Define etiquetas personalizadas para los ejecutables
Las etiquetas definidas en el campo labels
para un ejecutable solo se aplican a ese ejecutable.
Puedes definir etiquetas para uno o más ejecutables cuando creas un trabajo con gcloud CLI o la API de Batch.
gcloud
Por ejemplo, para crear un trabajo en us-central1
que defina dos etiquetas personalizadas, una para cada uno de los dos ejecutables del trabajo, sigue estos pasos:
Crea un archivo JSON que especifique los detalles de configuración del trabajo y los campos
runnables.labels
.{ "taskGroups": [ { "taskSpec": { "runnables": [ { "container": { "imageUri": "gcr.io/google-containers/busybox", "entrypoint": "/bin/sh", "commands": [ "-c", "echo Hello from task ${BATCH_TASK_INDEX}!" ] }, "labels": { "RUNNABLE1_LABEL_NAME1": "RUNNABLE1_LABEL_VALUE1" } }, { "script": { "text": "echo Hello from task ${BATCH_TASK_INDEX}!" }, "labels": { "RUNNABLE2_LABEL_NAME1": "RUNNABLE2_LABEL_VALUE1" } } ] } } ] }
Reemplaza lo siguiente:
RUNNABLE1_LABEL_NAME1
: Es el nombre de la etiqueta que se aplicará al primer ejecutable del trabajo.RUNNABLE1_LABEL_VALUE1
: Es el valor de la etiqueta que se aplicará al primer ejecutable del trabajo.RUNNABLE2_LABEL_NAME1
: Es el nombre de la etiqueta que se aplicará al segundo ejecutable del trabajo.RUNNABLE2_LABEL_VALUE1
: Es el valor de la etiqueta que se aplicará al segundo ejecutable del trabajo.
Crea el trabajo en
us-central1
con el comandogcloud batch jobs submit
.gcloud batch jobs submit example-job \ --config=JSON_CONFIGURATION_FILE \ --location=us-central1
Reemplaza
JSON_CONFIGURATION_FILE
por la ruta de acceso al archivo JSON con los detalles de configuración del trabajo que creaste en el paso anterior.
API
Por ejemplo, para crear un trabajo en us-central1
que defina dos etiquetas personalizadas, una para cada uno de los dos ejecutables del trabajo, realiza una solicitud POST
al método jobs.create
y especifica los campos runnables.labels
.
POST https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?job_id=example-job
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"container": {
"imageUri": "gcr.io/google-containers/busybox",
"entrypoint": "/bin/sh",
"commands": [
"-c",
"echo Hello from ${BATCH_TASK_INDEX}!"
]
},
"labels": {
"RUNNABLE1_LABEL_NAME1": "RUNNABLE1_LABEL_VALUE1"
}
},
{
"script": {
"text": "echo Hello from ${BATCH_TASK_INDEX}!"
},
"labels": {
"RUNNABLE2_LABEL_NAME1": "RUNNABLE2_LABEL_VALUE1"
}
}
]
}
}
]
}
Reemplaza lo siguiente:
RUNNABLE1_LABEL_NAME1
: Es el nombre de la etiqueta que se aplicará al ejecutable del primer trabajo.RUNNABLE1_LABEL_VALUE1
: Es el valor de la etiqueta que se aplicará al ejecutable del primer trabajo.RUNNABLE2_LABEL_NAME1
: Es el nombre de la etiqueta que se aplicará al ejecutable del segundo trabajo.RUNNABLE2_LABEL_VALUE1
: Es el valor de la etiqueta que se aplicará al ejecutable del segundo trabajo.
Java
Node.js
Python
¿Qué sigue?
Usa etiquetas como filtros cuando realices las siguientes acciones:
Obtén más información para borrar trabajos.