Aller au contenu
Documentation

Commandes du Runner

Chaque commande est champrep-code-runner <command>. Ajouter -h à n’importe quelle commande pour afficher ses options, par exemple champrep-code-runner service -h.

TâcheCommande
Connectez cette machine à un runnerchamprep-code-runner register --url https://code.champrep.com
Exécutez dans ce terminalchamprep-code-runner run
Installez-le en tant que service et lancez-lechamprep-code-runner service install
Le service est-il en cours d’exécution ?champrep-code-runner service status
Arrêtez-le (les tâches en cours d’exécution se terminent d’abord)champrep-code-runner service stop
Relancez-lechamprep-code-runner service start
Vérifiez le jeton du runnerchamprep-code-runner verify
Afficher la version installéechamprep-code-runner version
Vérifiez le fichier de configurationchamprep-code-runner check-config

Fenêtre de terminal
champrep-code-runner run

Le programme d’exécution continue de fonctionner et récupère les tâches jusqu’à ce que vous l’arrêtiez. Appuyez sur Ctrl+C Appuyez une fois pour arrêter le service une fois les tâches terminées ; appuyez à nouveau pour les interrompre.

Un service lance le runner au démarrage et le redémarre en cas d’échec. Enregistrez d’abord la machine : service install refuse toute configuration ne comportant pas de runners.

Fenêtre 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 affiche running, stopped ou not installed. Il se termine avec le code 3 lorsque le service ne fonctionne pas, ce qui permet aux scripts de vérifier son état.

OptionSignification
--config PATHLa configuration utilisée par le service.
--name NAMENom du service. Utilisez des noms différents pour exécuter plusieurs runners avec des configurations distinctes sur une même machine.
--user USERExécutez le service en tant que cet utilisateur plutôt qu’en tant que root ou LocalSystem.

En tant qu’administrateur, le programme d’exécution installe un service systemd nommé champrep-code-runner. En tant qu’ autre utilisateur, il installe un service utilisateur, qui s’exécute tant que vous êtes connecté (utilisez loginctl enable-linger pour le maintenir en fonctionnement). Vous pouvez également utiliser systemd directement :

Fenêtre de terminal
systemctl status champrep-code-runner
journalctl -u champrep-code-runner -f # follow the logs

Pour l’exécuteur Docker, l’utilisateur du service doit disposer d’un accès au socket Docker, ce qui équivaut à un accès root sur cette machine. Utilisez une machine de compilation dédiée.

En tant qu’administrateur, le programme d’exécution installe un LaunchDaemon (com.champrep.code-runner) qui se lance au démarrage. Sous un autre utilisateur, il installe un LaunchAgent qui s’exécute tant que vous êtes connecté, ce qui convient aux tâches nécessitant le trousseau, le simulateur ou la signature de code. Journaux :

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

À partir d’une invite PowerShell avec privilèges élevés :

Fenêtre de terminal
champrep-code-runner.exe service install
Get-Service champrep-code-runner

Le service exécute le binaire à partir de l’emplacement où il se trouve ; veuillez donc le copier au préalable dans un emplacement stable . Les journaux sont enregistrés dans champrep-code-runner.log à côté du fichier de configuration (%ProgramData%\champrep-runner\).

CommandeFonctionnalités
registerVérifiez un jeton de runner et ajoutez le runner à la configuration.
verify [--name N]Vérifie les jetons des exécuteurs configurés ; renvoie le code de sortie 1 si l’un d’entre eux est invalide.
runS’exécute jusqu’à ce qu’on l’arrête. --log-file PATH enregistre les journaux dans un fichier.
run-single [--name N] [--max-jobs 1]Exécute les tâches d’un seul exécuteur, puis se ferme. Utile pour les machines à durée de vie limitée.
service install|start|stop|status|uninstallGérez le Runner comme un service.
reset-token [--name N]Obtenez un nouveau jeton et enregistrez-le. L’ancien jeton continue de fonctionner pendant une courte période de grâce.
unregister --name N ou --allSupprimez le runner de cette machine de la configuration et de CodeCHAMPREP.
check-configVérifie la validité du fichier de configuration et affiche les avertissements.
versionAffiche la version, la révision et la plateforme.

Chaque commande accepte --config PATH pour utiliser un autre fichier de configuration.

Démarrez le Runner avec une adresse d’écoute pour exposer les points de terminaison de santé et de métriques :

Fenêtre de terminal
champrep-code-runner run --listen-address 127.0.0.1:9252
ParcoursSignification
/healthz200 pendant l’exécution du processus.
/readyz200 lorsque tous les runners sont vérifiés et demandent des tâches.
/metricsMétriques Prometheus : tâches en cours d’exécution, terminées et ayant échoué, et plus encore.

Les journaux sont au format JSON structuré et ne contiennent jamais de jetons, de variables ni de résultats de tâches.