Pular para o conteúdo
Documentation

Comandos do Runner

Cada comando é champrep-code-runner <command>. Adicione -h a qualquer comando para visualizar suas opções, por exemplo champrep-code-runner service -h.

TarefaComando
Conecte esta máquina a um executorchamprep-code-runner register --url https://code.champrep.com
Execute neste terminalchamprep-code-runner run
Instale como um serviço e inicie-ochamprep-code-runner service install
Ele está em execução?champrep-code-runner service status
Interrompa-o (as tarefas em execução serão concluídas primeiro)champrep-code-runner service stop
Inicie-o novamentechamprep-code-runner service start
Verifique o token do executorchamprep-code-runner verify
Exibir a versão instaladachamprep-code-runner version
Verifique o arquivo de configuraçãochamprep-code-runner check-config

Terminal window
champrep-code-runner run

O executor continua em execução e recebe tarefas até que o senhor o interrompa. Pressione Ctrl+C uma vez para interromper após a conclusão das tarefas em execução; pressione-o novamente para interrompê-las.

Um serviço inicia o executor na inicialização e o reinicia após uma falha. Registre a máquina primeiro: service install Recusa uma configuração sem executores.

Terminal window
sudo champrep-code-runner service install # install, enable at boot and start
champrep-code-runner service status # running, stopped or not installed
sudo champrep-code-runner service stop # running jobs finish first
sudo champrep-code-runner service start
sudo champrep-code-runner service uninstall # stop and remove the service

service status imprime running, stopped ou not installed. Ele encerra com o código 3 quando o serviço não está em execução, de modo que os scripts possam verificar isso.

OpçãoSignificado
--config PATHA configuração utilizada pelo serviço.
--name NAMEO nome do serviço. Utilize nomes diferentes para executar vários executores com configurações distintas em uma mesma máquina.
--user USERExecute o serviço como este usuário, em vez de como root ou LocalSystem.

Como root, o executor instala um serviço do systemd chamado champrep-code-runner. Como outro usuário, ele instala um serviço de usuário, que é executado enquanto você estiver conectado (use loginctl enable-linger para mantê-lo em execução). Você também pode usar o systemd diretamente:

Terminal window
systemctl status champrep-code-runner
journalctl -u champrep-code-runner -f # follow the logs

Para o executor do Docker, o usuário do serviço precisa de acesso ao soquete do Docker, o que equivale a ter privilégios de root naquela máquina. Utilize uma máquina dedicada à compilação.

Como root, o executor instala um LaunchDaemon (com.champrep.code-runner) que é iniciado na inicialização do sistema. Como outro usuário, ele instala um LaunchAgent que é executado enquanto você está conectado, o que é adequado para tarefas que exigem o keychain, o simulador ou a assinatura de código. Logs:

Terminal window
tail -f /Library/Logs/champrep-code-runner.log # LaunchDaemon
tail -f ~/Library/Logs/champrep-code-runner.log # LaunchAgent

Em um prompt do PowerShell com privilégios elevados:

Terminal window
champrep-code-runner.exe service install
Get-Service champrep-code-runner

O serviço executa o binário a partir do local em que está, portanto, copie-o para um local estável primeiro. Os logs são direcionados para champrep-code-runner.log ao lado da configuração (%ProgramData%\champrep-runner\).

ComandoO que ele faz
registerVerifique um token do executor e adicione o executor à configuração.
verify [--name N]Verifica os tokens dos executores configurados; retorna 1 quando um deles estiver inválido.
runExecute até ser interrompido. --log-file PATH grava logs em um arquivo.
run-single [--name N] [--max-jobs 1]Execute tarefas de um executador e, em seguida, encerre. Útil para máquinas de curta duração.
service install|start|stop|status|uninstallGerencie o executador como um serviço.
reset-token [--name N]Obtenha um novo token e salve-o. O token antigo continuará funcionando por um curto período de carência.
unregister --name N ou --allRemova o executador desta máquina da configuração e do CodeCHAMPREP.
check-configValida o arquivo de configuração e exibe avisos.
versionImprima a versão, a revisão e a plataforma.

Cada comando aceita --config PATH para usar outro arquivo de configuração.

Inicie o executador com um endereço de escuta para expor os endpoints de integridade e métricas:

Terminal window
champrep-code-runner run --listen-address 127.0.0.1:9252
CaminhoSignificado
/healthz200 enquanto o processo é executado.
/readyz200 quando todos os executores estiverem verificados e solicitando tarefas.
/metricsMétricas do Prometheus: tarefas em execução, concluídas e com falha, entre outras.

Os logs são em JSON estruturado e nunca contêm tokens, variáveis ou resultados de tarefas.