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.
Commandes quotidiennes
Section intitulée « Commandes quotidiennes »| Tâche | Commande |
|---|---|
| Connectez cette machine à un runner | champrep-code-runner register --url https://code.champrep.com |
| Exécutez dans ce terminal | champrep-code-runner run |
| Installez-le en tant que service et lancez-le | champrep-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-le | champrep-code-runner service start |
| Vérifiez le jeton du runner | champrep-code-runner verify |
| Afficher la version installée | champrep-code-runner version |
| Vérifiez le fichier de configuration | champrep-code-runner check-config |
Exécution dans un terminal
Section intitulée « Exécution dans un terminal »champrep-code-runner runLe 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.
Exécution en tant que service
Section intitulée « Exécution en tant que service »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.
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 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.
| Option | Signification |
|---|---|
--config PATH | La configuration utilisée par le service. |
--name NAME | Nom du service. Utilisez des noms différents pour exécuter plusieurs runners avec des configurations distinctes sur une même machine. |
--user USER | Exé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 :
systemctl status champrep-code-runnerjournalctl -u champrep-code-runner -f # follow the logsPour 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 :
tail -f /Library/Logs/champrep-code-runner.log # LaunchDaemontail -f ~/Library/Logs/champrep-code-runner.log # LaunchAgentÀ partir d’une invite PowerShell avec privilèges élevés :
champrep-code-runner.exe service installGet-Service champrep-code-runnerLe 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\).
Toutes les commandes
Section intitulée « Toutes les commandes »| Commande | Fonctionnalités |
|---|---|
register | Vé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. |
run | S’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|uninstall | Gé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 --all | Supprimez le runner de cette machine de la configuration et de CodeCHAMPREP. |
check-config | Vérifie la validité du fichier de configuration et affiche les avertissements. |
version | Affiche la version, la révision et la plateforme. |
Chaque commande accepte --config PATH pour utiliser un autre fichier de configuration.
Contrôles d’intégrité et métriques
Section intitulée « Contrôles d’intégrité et métriques »Démarrez le Runner avec une adresse d’écoute pour exposer les points de terminaison de santé et de métriques :
champrep-code-runner run --listen-address 127.0.0.1:9252| Parcours | Signification |
|---|---|
/healthz | 200 pendant l’exécution du processus. |
/readyz | 200 lorsque tous les runners sont vérifiés et demandent des tâches. |
/metrics | Mé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.