Visão geral
Neste guia, você pode aprender como implantar sua compilação de agente na produção a partir da CLI. Antes de implementar, certifique-se de construir a imagem do agente .
Sintaxe de comando e opções
Use os seguintes comandos para gerenciar seu sistema:
Iniciar uma implantação
Use a seguinte sintaxe para distribuir a compilação do agente :
agentengine deploy [--auto] [--build-id <id>] [--version <version>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>] [--no-wait] [--timeout <duration>] [--workspace <name>] [--all] [--json] [--yes]
Este comando inicia uma implementação da sua última compilação bem-sucedida ou de uma compilação específica se você fornecer um ID de compilação. O comando pesquisa o status do sistema a cada 5 segundos até que o sistema tenha um status succeeded, failed ou rolled_back, ou o valor de tempo limite seja atingido.
Importante
Acesso ao sistema de arquivos
Após distribuir seu agente, certifique-se de gravar arquivos locais somente nos diretórios /tmp ou /scratch. Não use outros caminhos, como /var ou diretórios inicial, porque eles podem não ser graváveis no ambiente de tempo de execução.
Sinalizadores de comando
Ao implementar sua compilação, você pode usar as seguintes sinalizações opcionais:
bandeira | Descrição |
|---|---|
| Constrói o agente e monitora a implementação que a compilação aciona. Esse sinalizador se aplica somente a projetos de agente único. Use este sinalizador para construir e implantar em uma etapa em vez de executar os dois comandos separadamente. |
| O ID de construção a ser implementado. Por padrão, o comando implementa a última compilação bem-sucedida do espaço de trabalho. Este sinalizador é mutuamente exclusivo com |
| Implementa a compilação de lançamento para esta versão |
| O ID do espaço de trabalho da plataforma. Por padrão, a CLI lê este valor do arquivo |
| O ID do projeto da plataforma . Por padrão, a CLI lê este valor do arquivo |
| O ID da organização. Por padrão, a CLI lê esse valor do seu estado de autenticação armazenado localmente. |
| O URL base da API da plataforma. |
| O contexto local nomeado do arquivo |
| Instrui a CLI a retornar imediatamente após iniciar a implementação sem pesquisar o status. |
| O tempo máximo para aguardar a conclusão do sistema. Por padrão, o sistema atinge o tempo limite após 30 minutos. |
| (Somente Monorepo) Implanta um espaço de trabalho específico por nome, conforme definido na raiz |
| (Somente Monorepo) Distribui todos os espaços de trabalho sequencialmente. Este sinalizador é mutuamente exclusivo com |
| Gera o resultado do sistema como JSON. |
| Aceita os padrões Flex cobrados e alterações na lista de acesso IP do Atlas quando o comando deployment executa a configuração do Atlas . |
Listar sistemas
Para ver o histórico de implantação do seu espaço de trabalho, execute o seguinte comando:
agentengine deploy list [--workspace <name>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>] [--status <status>] [--limit <n>] [--offset <n>] [--json]
Este comando exibe todas as implantações do espaço de trabalho atual, incluindo ID de implantação, status, executor, ID de compilação, imagem, tempo de criação, versão e mensagem de erro.
Sinalizadores de comando
bandeira | Descrição |
|---|---|
| (Somente Monorepo) Seleciona um espaço de trabalho específico pelo nome, conforme definido na raiz |
| O ID do espaço de trabalho da plataforma. Por padrão, a CLI lê este valor do arquivo |
| O ID do projeto da plataforma . Por padrão, a CLI lê este valor do arquivo |
| O ID da organização. Por padrão, a CLI lê esse valor do seu estado de autenticação armazenado localmente. |
| O URL base da API da plataforma. |
| O contexto local nomeado do arquivo |
| Filtra resultados por status de sistema, por exemplo |
| O número máximo de sistemas a retornar. |
| O número de sistemas a ignorar. |
| Produz a lista de sistema como JSON. |
Verificar o status da implantação
Para visualizar o status detalhado de um sistema, execute o seguinte comando:
agentengine deploy get [<deployment_id>] [-f] [--workspace <name>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>] [--json]
Por padrão, este comando retorna um snapshot pontual da implantação mais recente. Forneça um ID de sistema para verificar um sistema específico. O resultado inclui o status de implantação, ID de compilação, versão, imagem, condições, prontidão do componente e informações de saúde ao vivo.
Sinalizadores de comando
bandeira | Descrição |
|---|---|
| Transmita eventos de implantação em tempo real usando eventos enviados pelo servidor (SSE) até que a implantação atinja um estado terminal. Se a implantação já estiver em um estado de terminal, o comando relatará que não há nada para transmitir. |
| (Somente Monorepo) Seleciona um workspace específico por nome. |
| O ID do espaço de trabalho da plataforma. Por padrão, a CLI lê este valor do arquivo |
| O ID do projeto da plataforma . Por padrão, a CLI lê este valor do arquivo |
| O ID da organização. Por padrão, a CLI lê esse valor do seu estado de autenticação armazenado localmente. |
| O URL base da API da plataforma. |
| O contexto local nomeado do arquivo |
| Gera o status de implementação como JSON. |
Visualizar registro de eventos de implantação
Para visualizar o registro de evento estruturado de um sistema, execute o seguinte comando:
agentengine deploy logs [<deployment_id>] [-f] [--severity <level>] [--category <category>] [--limit <n>] [--workspace <name>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>] [--json]
Este comando recupera o registro de evento da implantação especificada, mostrando cada transição de estado da criação à conclusão. Se você não fornecer um ID de sistema, o comando mostrará o registro de evento do sistema mais recente. Você pode usar o registro de evento para rastrear o comportamento do sistema, investigar falhas e verificar se ocorreram transições esperadas do ciclo de vida.
Quando uma implementação não é bem-sucedida, o evento para o componente com falha inclui um código de saída e um breve motivo para a falha.
Observação
O sinalizador --json não pode ser combinado com os sinalizadores --follow, --severity ou --category.
Sinalizadores de comando
bandeira | Descrição |
|---|---|
| Pesquisa novos eventos até que a implantação atinja um estado terminal. |
| Filtra eventos por nível de gravidade: |
| Filtra eventos por categoria, por exemplo |
| O número máximo de eventos para retornar por página. O padrão é 100. |
| (Somente Monorepo) Seleciona um workspace específico por nome. |
| O ID do espaço de trabalho da plataforma. Por padrão, a CLI lê este valor do arquivo |
| O ID do projeto da plataforma . Por padrão, a CLI lê este valor do arquivo |
| O ID da organização. Por padrão, a CLI lê esse valor do seu estado de autenticação armazenado localmente. |
| O URL base da API da plataforma. |
| O contexto local nomeado do arquivo |
| Gera o registro de evento como JSON. |
Cancelar um sistema
Para cancelar uma implantação em andamento, use o seguinte comando:
agentengine deploy cancel <deployment_id> [--workspace <name>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>]
Este comando retorna um erro se o sistema já estiver em um estado succeeded, failed ou rolled_back.
Sinalizadores de comando
bandeira | Descrição |
|---|---|
| (Somente Monorepo) Seleciona um workspace específico por nome, conforme definido no arquivo raiz |
| O ID do espaço de trabalho da plataforma. Por padrão, a CLI lê este valor do arquivo |
| O ID do projeto da plataforma . Por padrão, a CLI lê este valor do arquivo |
| O ID da organização. Por padrão, a CLI lê esse valor do seu estado de autenticação armazenado localmente. |
| O URL base da API da plataforma. |
| O contexto local nomeado do arquivo |
Limites de construção
A plataforma força os seguintes limites de construção para cada projeto:
Limite | Valor |
|---|---|
Construções ativas simultâneas | 10 |
Construções diárias durante um período contínuo de 24 horas | 100 |
Se você exceder um limite de compilação, a solicitação retornará um erro 400 Bad Request com uma mensagem RESOURCE_LIMIT_EXCEEDED.
Para revisar todas as limitações que se aplicam durante a visualização pública, consulte Limitações do mecanismo do agente do MongoDB Atlas .
Exemplo
O exemplo a seguir mostra como implantar a última compilação bem-sucedida, verificar o status dessa implantação e, em seguida, cancelá-la.
Inicie uma implementação.
Execute o seguinte comando para implantar a última compilação bem-sucedida e retornar imediatamente sem pesquisar o status:
agentengine deploy --no-wait
Se a implementação for iniciada com êxito, o resultado será semelhante ao seguinte:
Deploying last successful build... ✓ Deployment started (deployment_id: deploy-9fb9e685)
Verifique o status da implementação.
Execute o seguinte comando para verificar o status do sistema usando o ID de sistema da etapa anterior:
agentengine deploy get deploy-9fb9e685
A saída se assemelha ao seguinte:
Deployment: deploy-9fb9e685 Status: in_progress (started 45s ago) Trigger: build Build: bld_01... Version: v0.1.0 (r1) Conditions: Available False NotAvailable — One or more components are not available. Components: Orchestration Engine 0/1 not ready Agent Sandbox 1/1 ready Tool Sandbox 1/1 ready Health: unavailable
Próximos passos
Depois de distribuir seu agente, você pode monitorar seu desempenho e atividade. Para saber como monitorar seu agente, consulte o guia Monitorar.
Para saber mais sobre os requisitos mínimos para executar um agente no Atlas Agent Engine, consulte a seção Contrato do agente da documentação do MongoDB Atlas Agent Engine.