Gestionar grupos de agentes

Un grupo de agentes es una colección de agentes que usan la misma configuración, con acceso y visibilidad uniformes a tu origen y destino. Los grupos de agentes también permiten controlar los límites de ancho de banda de transferencia.

Todos los agentes deben pertenecer a un grupo de agentes.

En esta guía se describe cómo usar los grupos de agentes.

Antes de empezar

Debes tener los permisos adecuados en tu proyecto para trabajar con grupos de agentes. Consulta más información en el artículo Control de acceso con la gestión de identidades y accesos.

Puedes ver tus permisos actuales.

Para usar los comandos gcloud, instala la herramienta de línea de comandos gcloud.

Crear un grupo de agentes

No incluyas información sensible, como información personal identificable (IPI) o datos de seguridad, en el nombre del grupo de agentes ni en el prefijo del ID de agente. Los nombres de recursos pueden propagarse a los nombres de otros recursos de Google Cloud y pueden exponerse a sistemas internos de Google fuera de tu proyecto.

Para crear un grupo de agentes, sigue estos pasos:

Google Cloud consola

  1. En la Google Cloud consola, ve a la página Grupos de agentes.

    Ir a Grupos de agentes

    Se muestra la página Grupos de agentes, con los grupos de agentes que ya tienes.

  2. Haz clic en Crear otro grupo.

  3. Ponle un nombre a tu grupo y, si quieres, descríbelo.

  4. Puede definir un límite de ancho de banda que se aplique a todo el grupo. El ancho de banda especificado en MB/s se dividirá entre todos los agentes del grupo. Consulta más información en el artículo Gestionar el ancho de banda de la red.

  5. Haz clic en Crear.

API REST

Usa projects.agentPools.create:

POST https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools?agent_pool_id=AGENT_POOL_ID

Donde:

  • PROJECT_ID: el ID del proyecto en el que vas a crear el grupo de agentes.
  • AGENT_POOL_ID: el ID del grupo de agentes que vas a crear.

Si un grupo de agentes se queda en el estado Creating durante más de 30 minutos, te recomendamos que lo elimines y lo vuelvas a crear.

Si se revocan los permisos necesarios del Servicio de transferencia de Storage de un proyecto mientras un grupo de agentes está en el estado Creating, el servicio no funcionará correctamente.

CLI de gcloud

Para crear un grupo de agentes con la herramienta de línea de comandos gcloud, ejecuta gcloud transfer agent-pools create.

gcloud transfer agent-pools create AGENT_POOL

Donde están disponibles las siguientes opciones:

  • AGENT_POOL es un identificador único y permanente de este grupo.

  • --no-async bloquea otras tareas en tu terminal hasta que se haya creado el grupo. Si no se incluye, la creación del grupo se ejecuta de forma asíncrona.

  • --bandwidth-limit define la cantidad de ancho de banda en MB/s que se va a poner a disposición de los agentes de este grupo. El límite de ancho de banda se aplica a todos los agentes de un grupo y puede ayudar a que la carga de trabajo de transferencia del grupo no afecte al resto de las operaciones que compartan tu ancho de banda. Por ejemplo, introduce "50" para definir un límite de ancho de banda de 50 MB/s. Si no se especifica esta marca, los agentes de este grupo usarán todo el ancho de banda disponible.

  • --display-name es un nombre modificable que te ayudará a identificar este grupo. Puedes incluir detalles que no quepan en el nombre completo único del recurso del grupo.

Asignar agentes a un grupo

Los nuevos grupos de agentes están vacíos y deben tener agentes asignados. Un agente solo se puede asignar a un grupo de agentes en el momento de su creación.

Si no se especifica ningún grupo de agentes, el agente se asigna al grupo transfer_service_default.

Para crear un agente y asignarlo a un grupo, sigue estos pasos:

Google Cloud consola

  1. En la página Grupos de agentes, selecciona el grupo al que quieras asignar los agentes.

  2. Haz clic en Instalar agente. Aparecerá la guía de instalación del agente.

  3. Sigue las instrucciones para crear el agente en este grupo de agentes.

CLI de gcloud

Para usar la herramienta de línea de comandos gcloud para crear un agente y asignarlo a un pool, ejecuta gcloud transfer agents install. El agente debe instalarse en una máquina con acceso raíz al sistema de archivos.

gcloud transfer agents install --pool=AGENT_POOL

Para instalar agentes que se puedan usar con una fuente compatible con S3, proporciona credenciales de acceso como variables de entorno con los valores de AWS_ACCESS_KEY_ID y AWS_SECRET_ACCESS_KEY, o bien guárdalas como credenciales predeterminadas en los archivos de configuración de tu sistema.

export AWS_ACCESS_KEY_ID=ID
export AWS_SECRET_ACCESS_KEY=SECRET
gcloud transfer agents install --pool=AGENT_POOL

Consulta más información en el artículo Gestionar agentes de transferencia.

Para ver más opciones, consulta Opciones avanzadas del agente.

Para gestionar agentes, consulta Gestionar agentes de transferencia.

Asignar un grupo de agentes a un trabajo

Una vez que se haya creado el grupo de agentes, se podrá asignar a un trabajo durante la creación o la actualización del trabajo.

Actualizar un grupo de agentes

Puedes actualizar el nombre visible y el límite de ancho de banda de un grupo de agentes.

Para actualizar un grupo de agentes, sigue estos pasos:

Google Cloud consola

En la Google Cloud consola, ve a la página Grupos de agentes.

Ir a Grupos de agentes

Puedes editar los siguientes elementos:

  • Nombre visible del grupo de agentes: haz clic en Editar junto al nombre del grupo de agentes.

  • Límite de ancho de banda del grupo de agentes: haz clic en Configurar límite de ancho de banda e introduce un nuevo límite en el cuadro de diálogo Configurar límite de ancho de banda. Haz clic en Definir límite para aplicar el nuevo límite de ancho de banda. El ancho de banda se comparte entre todos los agentes del grupo.

API REST

Para actualizar un grupo de agentes, usa projects.agentPools.patch con una máscara de campo de los campos que quieras actualizar. Se pueden actualizar los siguientes campos del grupo de agentes:

Por ejemplo, para cambiar el valor de displayName a my-transfer, debe proporcionar la máscara de campo "displayName,my-transfer".

A continuación, se muestra un ejemplo de solicitud de parche para actualizar el nombre visible:

PATCH https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL:"displayName,NEW_DISPLAY_NAME"

Donde:

  • PROJECT_ID: el ID del proyecto en el que vas a actualizar el grupo de agentes.
  • AGENT_POOL: El nombre del grupo de agentes que vas a actualizar.
  • NEW_DISPLAY_NAME: el nuevo nombre visible de este grupo de agentes.

A continuación, se muestra un ejemplo de solicitud PATCH para actualizar el límite de ancho de banda:

PATCH https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL:"bandwidthLimit,NEW_LIMIT"

Donde:

  • PROJECT_ID: el ID del proyecto en el que vas a actualizar el grupo de agentes.
  • AGENT_POOL: ID del grupo de agentes que quieres actualizar.
  • NEW_LIMIT: el nuevo límite de ancho de banda de este grupo de agentes.

CLI de gcloud

Para usar la herramienta de línea de comandos gcloud y actualizar un grupo de agentes, ejecuta gcloud transfer agent-pools update.

gcloud transfer agent-pools update AGENT_POOL \
  [--bandwidth-limit=NEW_BANDWIDTH_LIMIT] [--clear-bandwidth-limit] \
  [--clear-display-name] [--display-name=NEW_DISPLAY_NAME]

Es obligatorio indicar el siguiente argumento:

  • AGENT_POOL es el identificador único y permanente de este grupo. AGENT_POOL identifica el grupo de agentes que se va a actualizar y no se puede actualizar.

Con este comando se pueden especificar las siguientes marcas:

  • --bandwidth-limit se puede actualizar o quitar especificando --clear-bandwidth-limit. Consulta Crear un grupo de agentes para obtener más información sobre los límites de ancho de banda.

  • --display-name se puede actualizar o eliminar con la marca --clear-display-name en su lugar.

Eliminar un grupo de agentes

Puedes eliminar un grupo de agentes que no tenga agentes activos ni ejecuciones de trabajos activas.

Para eliminar un pool de agentes, sigue estos pasos:

Google Cloud consola

  1. En la Google Cloud consola, ve a la página Grupos de agentes.

    Ir a Grupos de agentes

  2. Haz clic en Eliminar. Lee la ventana emergente y, a continuación, haz clic en Eliminar para confirmar la acción.

    Si el botón Eliminar no está activo, tendrás que detener todos los agentes y trabajos asociados a este grupo.

API REST

Usa projects.agentPools.delete:

DELETE https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL

Donde:

  • PROJECT_ID: ID del proyecto del que quieres eliminar el grupo de agentes.
  • AGENT_POOL: el nombre del grupo de agentes.

CLI de gcloud

Para usar la herramienta de línea de comandos gcloud para eliminar un grupo de agentes, ejecuta gcloud transfer agent-pools delete.

gcloud transfer agent-pools delete AGENT_POOL

Es obligatorio indicar el siguiente argumento:

  • AGENT_POOL es el identificador único y permanente de este grupo.

Para poder eliminar un grupo, todos los agentes del grupo deben estar detenidos, las tareas del grupo deben estar inhabilitadas y no debe haber operaciones de transferencia en curso en el grupo.

Para ver todos los trabajos asociados a un grupo, selecciona el grupo en la consola de Google Cloud y haz clic en la pestaña Tareas de transferencia.

Obtener un grupo de agentes

Para obtener un grupo de agentes, sigue estos pasos:

Google Cloud consola

En la Google Cloud consola, ve a la página Grupos de agentes.

Ir a Grupos de agentes

En la página se muestra una lista de todos los grupos de agentes asociados a tu proyecto, así como la siguiente información de cada grupo de agentes:

  • Nombre del grupo de agentes
  • Estado de conexión
  • Número de agentes conectados
  • Límite de ancho de banda, si se ha definido
  • Número de tareas de transferencia asociadas
  • Nombre visible del grupo de agentes

Para ver un grupo de agentes específico, haz clic en su nombre.

En la página de información de un grupo de agentes, puedes hacer lo siguiente:

  • Instalar agente: muestra instrucciones para instalar agentes de Transfer.
  • Detener agente: selecciona un agente en la tabla y, a continuación, haz clic en Detener agente.
  • Lista de tareas de transferencia: haz clic en Tareas de transferencia para ver las tareas de transferencia a las que están conectados los agentes de este grupo.

API REST

Usa projects.agentPools.get:

GET https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL

Donde:

  • PROJECT_ID: el ID del proyecto del que vas a obtener un grupo de agentes.
  • AGENT_POOL: el grupo de agentes que se va a recuperar.

CLI de gcloud

Para usar la herramienta de línea de comandos gcloud y recuperar un grupo de agentes, ejecuta gcloud transfer agent-pools describe.

gcloud transfer agent-pools describe AGENT_POOL

Es obligatorio indicar el siguiente argumento:

  • AGENT_POOL es el identificador único y permanente de este grupo.

Mostrar grupos de agentes

Para enumerar tus grupos de agentes, sigue estos pasos:

Google Cloud consola

En la Google Cloud consola, ve a la página Grupos de agentes.

Ir a Grupos de agentes

Se muestran todos los grupos de agentes.

API REST

Usa projects.agentPools.list:

GET https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools

Donde:

  • PROJECT_ID: ID del proyecto del que se van a enumerar los grupos de agentes.

CLI de gcloud

Para usar la herramienta de línea de comandos gcloud y enumerar los grupos de agentes, ejecuta gcloud transfer agent-pools list.

gcloud transfer agent-pools list \
  [--limit=LIMIT] \
  [--names=[NAMES,...]] \
  [--page-size=PAGE_SIZE]

Con este comando se pueden especificar las siguientes marcas:

  • --limit define el número máximo de grupos de agentes que se devolverán.

  • --names especifica los nombres de los grupos de agentes que se van a enumerar. Separa los nombres con comas. Por ejemplo, --names=foo,bar. Si no se especifica, se mostrarán todos los grupos de agentes de tu proyecto actual.

  • --page-size define el comportamiento de la creación de lotes de este comando. De forma predeterminada, el comando list agrupa las respuestas en lotes de 256 elementos y obtiene automáticamente el siguiente lote hasta que se hayan enumerado todos los elementos o se haya alcanzado el valor limit.

El comando devuelve una lista de grupos de agentes coincidentes y los detalles de su configuración. En el ejemplo siguiente se muestra una respuesta de muestra.

name: projects/my-project-123/agentPools/my-first-pool
state: CREATED
---
bandwidthLimit:
  limitMbps: '120'
displayName: Source A to destination Z.
name: projects/my-project-123/agentPools/a2z-pool
state: CREATED