Um conjunto de agentes é uma coleção de agentes que usam a mesma configuração, com acesso e visibilidade uniformes à sua origem e destino. Os conjuntos de agentes também oferecem controlo sobre os limites de largura de banda de transferência.
Todos os agentes têm de pertencer a um conjunto de agentes.
Este guia descreve como usar conjuntos de agentes.
Antes de começar
Tem de ter as autorizações corretas no seu projeto para trabalhar com conjuntos de agentes. Consulte o artigo Controlo de acesso com a IAM para ver detalhes.
Pode ver as suas autorizações atuais.
Para usar os comandos gcloud,
instale a ferramenta de linhas de comando gcloud.
Crie um conjunto de agentes
Para criar um conjunto de agentes:
Google Cloud consola
Na Google Cloud consola, aceda à página Pools de agentes.
É apresentada a página Conjuntos de agentes, que lista os conjuntos de agentes existentes.
Clique em Criar outro conjunto.
Atribua um nome ao conjunto e, opcionalmente, descreva-o.
Pode optar por definir um limite de largura de banda que se aplica ao conjunto como um todo. A largura de banda especificada em MB/s é dividida entre todos os agentes no conjunto. Consulte o artigo Faça a gestão da largura de banda da rede para mais informações.
Clique em Criar.
API REST
Use projects.agentPools.create:
POST https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools?agent_pool_id=AGENT_POOL_ID
Onde:
PROJECT_ID: o ID do projeto no qual está a criar o conjunto de agentes.AGENT_POOL_ID: o ID do conjunto de agentes que está a criar.
Se um conjunto de agentes estiver bloqueado no estado Creating durante mais de 30 minutos,
recomendamos que elimine o conjunto de agentes e o crie novamente.
A revogação das autorizações necessárias do serviço de transferência de armazenamento de um projeto enquanto um conjunto de agentes está no estado Creating leva a um comportamento incorreto do serviço.
CLI gcloud
Para criar um conjunto de agentes com a ferramenta de linhas de comandos gcloud, execute gcloud transfer agent-pools create.
gcloud transfer agent-pools create AGENT_POOL
Onde estão disponíveis as seguintes opções:
AGENT_POOL é um identificador exclusivo e permanente deste conjunto.
--no-asyncbloqueia outras tarefas no terminal até que o conjunto seja criado. Se não for incluído, a criação do grupo é executada de forma assíncrona.--bandwidth-limitdefine a quantidade de largura de banda em MB/s a disponibilizar aos agentes deste conjunto. É aplicado um limite de largura de banda a todos os agentes num conjunto e pode ajudar a impedir que a carga de trabalho de transferência do conjunto interrompa outras operações que partilham a sua largura de banda. Por exemplo, introduza "50" para definir um limite de largura de banda de 50 MB/s. Se não especificar este indicador, os agentes deste conjunto usam toda a largura de banda disponível.--display-nameé um nome modificável para ajudar a identificar este conjunto. Pode incluir detalhes que podem não caber no nome completo do recurso exclusivo do conjunto.
Atribua agentes a um conjunto
Os novos conjuntos de agentes estão vazios e têm de ter agentes atribuídos. Só é possível atribuir um agente a um conjunto de agentes no momento da criação do agente.
Se não for especificado um conjunto de agentes, o agente é atribuído ao conjunto
transfer_service_default.
Para criar um agente e atribuí-lo a um conjunto:
Google Cloud consola
Na página Conjuntos de agentes, selecione o conjunto ao qual quer atribuir os agentes.
Clique em Instalar agente. É apresentado o guia de instalação do agente.
Siga as instruções para criar o agente neste conjunto de agentes.
CLI gcloud
Para usar a ferramenta de linha de comandos gcloud para criar um agente e atribuí-lo a um conjunto, execute gcloud transfer agents install. O agente tem de ser instalado numa máquina com acesso de raiz ao sistema de ficheiros.
gcloud transfer agents install --pool=AGENT_POOL
Para instalar agentes para utilização com uma origem compatível com S3, forneça credenciais de acesso como variáveis de ambiente, como os valores de AWS_ACCESS_KEY_ID e AWS_SECRET_ACCESS_KEY, ou armazenadas como credenciais predefinidas nos ficheiros de configuração do seu sistema.
export AWS_ACCESS_KEY_ID=ID
export AWS_SECRET_ACCESS_KEY=SECRET
gcloud transfer agents install --pool=AGENT_POOL
Consulte o artigo Faça a gestão dos agentes de transferência para mais detalhes.
Para mais opções, consulte as Opções avançadas do agente.
Para gerir agentes, consulte o artigo Faça a gestão dos agentes de transferência.
Atribua um conjunto de agentes a uma tarefa
Depois de criar o conjunto de agentes, pode atribuí-lo a uma tarefa durante a criação ou a atualização da tarefa.
Atualize um conjunto de agentes
Pode atualizar o nome a apresentar e o limite de largura de banda de um conjunto de agentes.
Para atualizar um conjunto de agentes:
Google Cloud consola
Na Google Cloud consola, aceda à página Pools de agentes.
Pode editar os seguintes itens:
O nome a apresentar do conjunto de agentes: clique em Editar junto ao nome atual do conjunto de agentes.
O limite de largura de banda do conjunto de agentes: clique em Definir limite de largura de banda e introduza um novo limite de largura de banda na caixa de diálogo Definir limite de largura de banda. Clique em Definir limite para aplicar o novo limite de largura de banda. A largura de banda é partilhada por todos os agentes no conjunto.
API REST
Para atualizar um conjunto de agentes, use
projects.agentPools.patch
com uma máscara de campo
dos campos a atualizar. É possível atualizar os seguintes campos do conjunto de agentes:
Por exemplo, para atualizar o displayName para my-transfer, forneceria a máscara de campo "displayName,my-transfer".
Segue-se um exemplo de um pedido PATCH para atualizar o nome a apresentar:
PATCH https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL:"displayName,NEW_DISPLAY_NAME"
Onde:
PROJECT_ID: o ID do projeto no qual está a atualizar o conjunto de agentes.AGENT_POOL: o nome do conjunto de agentes que está a atualizar.NEW_DISPLAY_NAME: o novo nome a apresentar para este conjunto de agentes.
Segue-se um exemplo de um pedido de patch para atualizar o limite de largura de banda:
PATCH https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL:"bandwidthLimit,NEW_LIMIT"
Onde:
PROJECT_ID: o ID do projeto no qual está a atualizar o conjunto de agentes.AGENT_POOL: o ID do conjunto de agentes que está a atualizar.NEW_LIMIT: o novo limite de largura de banda para este conjunto de agentes.
CLI gcloud
Para usar a ferramenta de linha de comandos gcloud para atualizar um conjunto de agentes, execute o comando
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]
O seguinte argumento é obrigatório:
- AGENT_POOL é o identificador exclusivo e permanente deste conjunto.
AGENT_POOLidentifica o conjunto de agentes a atualizar e não pode ser atualizado.
As seguintes flags podem ser especificadas com este comando:
--bandwidth-limitpode ser atualizado ou removido especificando--clear-bandwidth-limit. Consulte o artigo Crie um conjunto de agentes para mais detalhes sobre os limites de largura de banda.--display-namepode ser atualizado ou eliminado com a flag--clear-display-name.
Elimine um conjunto de agentes
Pode eliminar um conjunto de agentes que não tenha agentes ativos nem execuções de tarefas ativas.
Para eliminar um conjunto de agentes:
Google Cloud consola
Na Google Cloud consola, aceda à página Pools de agentes.
Clique em Eliminar. Leia o pop-up e, de seguida, clique em Eliminar para confirmar.
Se o botão de eliminação não estiver ativo, tem de parar todos os agentes e tarefas associados a este conjunto.
API REST
Use projects.agentPools.delete:
DELETE https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL
Onde:
PROJECT_ID: o ID do projeto do qual está a eliminar o grupo de agentes.AGENT_POOL: o nome do conjunto de agentes.
CLI gcloud
Para usar a ferramenta de linha de comandos gcloud para eliminar um conjunto de agentes, execute gcloud transfer agent-pools delete.
gcloud transfer agent-pools delete AGENT_POOL
O seguinte argumento é obrigatório:
- AGENT_POOL é o identificador exclusivo e permanente deste conjunto.
Antes de poder eliminar um conjunto, todos os agentes no conjunto têm de ser parados, os trabalhos do conjunto têm de ser desativados e não pode haver operações de transferência em curso para este conjunto.
Para ver todas as tarefas associadas a um conjunto, selecione o conjunto na consola Google Cloud e clique no separador Transferir tarefas.
Obtenha um conjunto de agentes
Para obter um conjunto de agentes:
Google Cloud consola
Na Google Cloud consola, aceda à página Pools de agentes.
A página apresenta uma lista de todos os conjuntos de agentes associados ao seu projeto e as seguintes informações para cada conjunto de agentes:
- Nome do conjunto de agentes
- Estado da ligação
- Número de agentes ligados
- Limite de largura de banda, se definido
- Número de tarefas de transferência associadas
- O nome a apresentar do conjunto de agentes
Para ver um conjunto de agentes específico, clique no nome do conjunto de agentes.
As seguintes ações estão disponíveis na página de informações de um conjunto de agentes:
- Instalar agente: apresenta instruções para instalar agentes de transferência.
- Parar agente: selecione um agente na tabela e, de seguida, clique em Parar agente.
- Listar tarefas de transferência: clique em Tarefas de transferência para apresentar os agentes de tarefas de transferência aos quais este conjunto está associado.
API REST
GET https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL
Onde:
PROJECT_ID: o ID do projeto do qual está a receber um conjunto de agentes.AGENT_POOL: o conjunto de agentes a obter.
CLI gcloud
Para usar a ferramenta de linhas de comandos gcloud para obter um conjunto de agentes, execute gcloud transfer agent-pools describe.
gcloud transfer agent-pools describe AGENT_POOL
O seguinte argumento é obrigatório:
- AGENT_POOL é o identificador exclusivo e permanente deste conjunto.
Apresentar pools de agentes
Para listar os seus conjuntos de agentes:
Google Cloud consola
Na Google Cloud consola, aceda à página Pools de agentes.
São apresentados todos os conjuntos de agentes.
API REST
GET https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools
Onde:
PROJECT_ID: o ID do projeto para o qual listar os conjuntos de agentes.
CLI gcloud
Para usar a ferramenta de linhas de comandos gcloud para apresentar uma lista de conjuntos de agentes, execute gcloud transfer agent-pools list.
gcloud transfer agent-pools list \
[--limit=LIMIT] \
[--names=[NAMES,...]] \
[--page-size=PAGE_SIZE]
As seguintes flags podem ser especificadas com este comando:
--limitdefine o número máximo de conjuntos de agentes a devolver.--namesespecifica os nomes dos conjuntos de agentes a apresentar. Separe vários nomes com vírgulas; por exemplo,--names=foo,bar. Se não for especificado, são apresentados todos os conjuntos de agentes no seu projeto atual.--page-sizedefine o comportamento de processamento em lote para este comando. Por predefinição, o comandolistagrupa as respostas em 256 itens, obtendo automaticamente o lote seguinte até que todos os itens sejam apresentados ou que se atinja o valorlimit.
O comando devolve uma lista de conjuntos de agentes correspondentes e os respetivos detalhes de configuração. O exemplo seguinte mostra uma resposta de exemplo.
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