Pular para o conteúdo
Documentation

Comandos do Runner Farm

champrep runner-farm, ou seu alias abreviado champrep rf, gerencia o CHAMPREP Runner Farm a partir do seu terminal: suas contas do farm, as conexões do host de código, os pools de runners e suas classes de máquina, os créditos e minutos que você utilizou e os trabalhos que o farm executou. Ele atua em seu nome, com seu login normal CLI , de modo que sua função na conta e seu plano se aplicam exatamente como no aplicativo web do Runner Farm.

  1. Instale o CLI e fazer login com champrep auth login.
  2. Seu plano deve incluir o Runner Farm, e o espaço de trabalho precisa de uma conta do Runner Farm . Crie a conta e adicione conexões no aplicativo web do Runner Farm em https://runners.champrep.com.

O senhor pode atuar em mais de uma conta da farm: a sua própria, a de uma organização ou a de uma equipe. Liste-as e, em seguida, escolha uma com --workspace:

Terminal window
champrep rf accounts ls
champrep rf pools ls --workspace organization:65f0c0ffee0000000000abcd

--workspace aceita o KEY coluna de accounts ls: personal, organization:<id> ou team:<id>. Sem essa configuração, a fazenda seleciona a conta da mesma forma que o aplicativo web: a conta da sua organização ou equipe, quando houver uma; caso contrário, a sua própria.

ComandoObjetivo
champrep rf accounts lsListe os espaços de trabalho nos quais o(a) senhor(a) pode atuar, sua função e se cada um possui uma conta de farm.
champrep rf accounts showMostrar a conta da fazenda: estado, a quem são cobrados os serviços, trabalhos simultâneos e o limite máximo de crédito mensal.
champrep rf connections lsListe as conexões do host de código com seu estado e os trabalhos em execução, retidos e em pool. --include-deleted, --limit (1-100).
champrep rf pools lsListar pools com classe de máquina, slots ocupados, trabalhos em espera e retidos. --connection ID, --state active|paused|draining|deleted, --search, --include-deleted, --limit (1-200).
champrep rf pools show POOL_IDMostrar um pool, seus limites, tempo limite e números para o ciclo atual.
champrep rf pools createAdicione um pool a uma conexão. Requer --connection, --name e --class; também --isolation, --max-concurrent, --min-idle, --timeout.
champrep rf pools update POOL_IDAlterar --name, --max-concurrent, --min-idle ou --timeout, ou --pause / --resume o pool.
champrep rf usageCréditos para o período de faturamento atual (incluídos, adquiridos, utilizados, restantes) e minutos e créditos por classe de máquina para este mês ou --period YYYY-MM.
champrep rf jobs lsListar trabalhos, começando pelos mais recentes, incluindo aqueles em espera, retidos e recusados. --state running,held, --pool ID, --billed-to-me, --limit (1-200).

OpçãoValores
--classcpu-2, cpu-4, cpu-8, arm64-2, arm64-4, build-4
--isolationshared_hardened (padrão) ou tenant_dedicated
--max-concurrentTrabalhos simultâneos, de 0 a 500
--min-idleTrabalhos em espera mantidos prontos, de 0 a 50
--timeoutTempo limite do trabalho de 15m até 6h, por exemplo 90m ou 2h

Seu plano determina quais classes, níveis de isolamento e limites você pode utilizar. Um pool que ultrapassou o plano após um downgrade exibe above plan em pools ls.

Veja onde seus trabalhos são executados e qual é o nível de ocupação dos pools:

Terminal window
champrep rf connections ls
champrep rf pools ls
champrep rf pools show pol_01HZX9K4

Adicione um pool para compilações de imagens e coloque-o em pausa para manutenção:

Terminal window
champrep rf pools create --connection con_01HZX7 --name Builds \
--class build-4 --max-concurrent 4 --timeout 2h --yes
champrep rf pools update pol_01HZX9K4 --pause --yes
champrep rf pools update pol_01HZX9K4 --resume --max-concurrent 8 --yes

Verifique o que você utilizou neste período e no mês passado:

Terminal window
champrep rf usage
champrep rf usage --period 2026-10

Encontre tarefas que estejam em espera ou retidas:

Terminal window
champrep rf jobs ls --state waiting,held

pools create e pools update perguntam antes de alterar qualquer coisa. Responda y em um terminal, ou passe --yes (-y) em um script. Sem um terminal e sem --yes o comando é recusado e não altera nada. pools create carrega uma chave de idempotência; portanto, a tentativa automática CLIdo após um erro de rede nunca adiciona dois pools.

Adicionar --json para exibir o que o Runner Farm retornou. usage --json imprime { "balance": …, "usage": …, "period": "YYYY-MM" }.

Terminal window
champrep rf pools ls --json | jq -r '.pools[] | "\(.id) \(.state) \(.busy)/\(.max_concurrent)"'

Os valores de crédito dependem da sua função: Proprietários e gerentes de cobrança sempre os visualizam; Administradores e membros os visualizam apenas quando a conta lhes atribui créditos. Os valores ocultos são exibidos como -.

Por motivos de segurança, o CLI não pode acessar nada que emita, substitua ou teste uma credencial. Utilize o aplicativo web do Runner Farm para:

  • criam uma conta de farm ou transferem uma para uma organização;
  • adicionam uma conexão, emparelham um CHAMPREPCódigo autogerenciado ou substituem um token de runner ou segredo de conector;
  • excluem ou restauram conexões e pools, encerram a conta e alteram a configuração de visibilidade de custos.

MensagemO que fazer
payment required … (INSUFFICIENT_CREDITS)O saldo não é suficiente para pagar pela classe da máquina. Compre créditos ou aguarde o próximo período; o CLI sugere CHAMPREP Faturamento. Código de saída 1.
payment required … (PENDING_INVOICE), (WORKSPACE_NOT_BILLED)A conta possui uma fatura pendente de pagamento ou seu plano expirou. Um proprietário ou gerente de cobrança deve regularizar a situação em CHAMPREP Faturamento.
needs your web session … (INTERACTIVE_SESSION_REQUIRED)Somente você, conectado ao aplicativo web, pode tomar essa decisão. Faça isso em https://runners.champrep.com.
not allowed for your role … (ROLE_REQUIRED)Sua função no espaço de trabalho não permite a alteração. Consulte um proprietário ou administrador.
not allowed for your role … (WORKSPACE_NOT_AVAILABLE)--workspace refere-se a um espaço de trabalho no qual você não está. Verifique champrep rf accounts ls.
not available to your account …Seu plano não inclui o Runner Farm, esta classe ou este limite.
rate limited … (CAPACITY_EXHAUSTED)Todos os slots estão ocupados. Aguarde e tente novamente; a compra de créditos não resolve o problema.
not found …Não existe tal pool ou conexão nesta conta, ou o espaço de trabalho ainda não possui uma conta de farm.

Essas recusas são encerradas com o código 1, também com --json. rate limited (CAPACITY_EXHAUSTED) encerra 5; consulte o códigos de saída.