Ir al contenido
Documentation

Comandos de Runner

Cada comando es champrep-code-runner <command>. Añada -h a cualquier comando para ver sus opciones; por ejemplo: champrep-code-runner service -h.

TareaComando
Conecte este equipo a un ejecutorchamprep-code-runner register --url https://code.champrep.com
Ejecute en esta terminalchamprep-code-runner run
Instálelo como servicio e inícielochamprep-code-runner service install
¿Se está ejecutando?champrep-code-runner service status
Deténgalo (las tareas en ejecución finalizarán primero)champrep-code-runner service stop
Inícielo de nuevochamprep-code-runner service start
Compruebe el token del ejecutorchamprep-code-runner verify
Mostrar la versión instaladachamprep-code-runner version
Compruebe el archivo de configuraciónchamprep-code-runner check-config

Ventana de terminal
champrep-code-runner run

El ejecutor sigue funcionando y recoge trabajos hasta que usted lo detenga. Pulse Ctrl+C Pulse una vez para detenerlo una vez finalizadas las tareas en ejecución; púlselo de nuevo para interrumpirlas.

Un servicio inicia el ejecutor al arrancar el sistema y lo reinicia tras un fallo. Registre primero el equipo: service install Rechaza una configuración que no incluya ejecutores.

Ventana de terminal
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 o not installed. Se cierra con el código 3 cuando el servicio no está en ejecución, por lo que los scripts pueden comprobarlo.

OpciónSignificado
--config PATHLa configuración que utiliza el servicio.
--name NAMEEl nombre del servicio. Utilice nombres diferentes para ejecutar varios «runners» con configuraciones distintas en una misma máquina.
--user USEREjecute el servicio como este usuario en lugar de como root o LocalSystem.

Como usuario root, el ejecutor instala un servicio de systemd denominado champrep-code-runner. Como otro usuario, instala un servicio de usuario, que se ejecuta mientras esté conectado (utilice loginctl enable-linger para mantenerlo en ejecución). También puede utilizar systemd directamente:

Ventana de terminal
systemctl status champrep-code-runner
journalctl -u champrep-code-runner -f # follow the logs

En el caso del ejecutor de Docker, el usuario del servicio necesita acceso al socket de Docker, lo que equivale a tener privilegios de root en esa máquina. Utilice una máquina dedicada a la compilación.

Como usuario root, el ejecutor instala un LaunchDaemon (com.champrep.code-runner) que se inicia al arrancar el sistema. Como otro usuario, instala un LaunchAgent que se ejecuta mientras está conectado, lo que resulta adecuado para tareas que requieren el llavero, el simulador o la firma de código. Registros:

Ventana de terminal
tail -f /Library/Logs/champrep-code-runner.log # LaunchDaemon
tail -f ~/Library/Logs/champrep-code-runner.log # LaunchAgent

Desde una línea de comandos de PowerShell con privilegios elevados:

Ventana de terminal
champrep-code-runner.exe service install
Get-Service champrep-code-runner

El servicio ejecuta el binario desde su ubicación actual, por lo que debe copiarlo primero en una ubicación estable . Los registros se guardan en champrep-code-runner.log junto a la configuración (%ProgramData%\champrep-runner\).

ComandoQué hace
registerCompruebe un token de «runner» y añada el «runner» a la configuración.
verify [--name N]Comprueba los tokens de los ejecutores configurados; sale con el código de salida 1 si alguno no es válido.
runEjecútelo hasta que se detenga. --log-file PATH escribe los registros en un archivo.
run-single [--name N] [--max-jobs 1]Ejecute los trabajos de un «runner» y, a continuación, salga. Resulta útil para máquinas de corta duración.
service install|start|stop|status|uninstallGestione el «runner» como un servicio.
reset-token [--name N]Obtenga un nuevo token y guárdelo. El token antiguo seguirá funcionando durante un breve periodo de gracia.
unregister --name N o --allElimine el «runner» de esta máquina de la configuración y de CodeCHAMPREP.
check-configValida el archivo de configuración y muestra advertencias.
versionMuestre la versión, la revisión y la plataforma.

Cada comando admite --config PATH para utilizar otro archivo de configuración.

Inicie el «runner» con una dirección de escucha para exponer los puntos finales de estado y métricas:

Ventana de terminal
champrep-code-runner run --listen-address 127.0.0.1:9252
RutaSignificado
/healthz200 mientras se ejecuta el proceso.
/readyz200 cuando todos los ejecutores están verificados y solicitan trabajos.
/metricsMétricas de Prometheus: trabajos en ejecución, finalizados y fallidos, entre otros.

Los registros están estructurados en JSON y nunca contienen tokens, variables ni resultados de los trabajos.