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.
Comandos diários
Seção intitulada “Comandos diários”| Tarefa | Comando |
|---|---|
| Conecte esta máquina a um executor | champrep-code-runner register --url https://code.champrep.com |
| Execute neste terminal | champrep-code-runner run |
| Instale como um serviço e inicie-o | champrep-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 novamente | champrep-code-runner service start |
| Verifique o token do executor | champrep-code-runner verify |
| Exibir a versão instalada | champrep-code-runner version |
| Verifique o arquivo de configuração | champrep-code-runner check-config |
Execute em um terminal
Seção intitulada “Execute em um terminal”champrep-code-runner runO 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.
Executar como serviço
Seção intitulada “Executar como serviço”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.
sudo champrep-code-runner service install # install, enable at boot and startchamprep-code-runner service status # running, stopped or not installedsudo champrep-code-runner service stop # running jobs finish firstsudo champrep-code-runner service startsudo champrep-code-runner service uninstall # stop and remove the serviceservice 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ção | Significado |
|---|---|
--config PATH | A configuração utilizada pelo serviço. |
--name NAME | O nome do serviço. Utilize nomes diferentes para executar vários executores com configurações distintas em uma mesma máquina. |
--user USER | Execute 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:
systemctl status champrep-code-runnerjournalctl -u champrep-code-runner -f # follow the logsPara 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:
tail -f /Library/Logs/champrep-code-runner.log # LaunchDaemontail -f ~/Library/Logs/champrep-code-runner.log # LaunchAgentWindows
Seção intitulada “Windows”Em um prompt do PowerShell com privilégios elevados:
champrep-code-runner.exe service installGet-Service champrep-code-runnerO 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\).
Todos os comandos
Seção intitulada “Todos os comandos”| Comando | O que ele faz |
|---|---|
register | Verifique 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. |
run | Execute 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|uninstall | Gerencie 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 --all | Remova o executador desta máquina da configuração e do CodeCHAMPREP. |
check-config | Valida o arquivo de configuração e exibe avisos. |
version | Imprima a versão, a revisão e a plataforma. |
Cada comando aceita --config PATH para usar outro arquivo de configuração.
Verificações de integridade e métricas
Seção intitulada “Verificações de integridade e métricas”Inicie o executador com um endereço de escuta para expor os endpoints de integridade e métricas:
champrep-code-runner run --listen-address 127.0.0.1:9252| Caminho | Significado |
|---|---|
/healthz | 200 enquanto o processo é executado. |
/readyz | 200 quando todos os executores estiverem verificados e solicitando tarefas. |
/metrics | Mé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.