Enregistrer un Runner
L’enregistrement permet de connecter une machine à un exécuteur que vous avez créé dans CHAMPREPCode. Vous avez besoin du jeton d’authentification, qui commence par ccrt_.
1. Créez le runner dans CodeCHAMPREP
Section intitulée « 1. Créez le runner dans CodeCHAMPREP »- Ouvrez votre projet (ou groupe) et rendez-vous à Paramètres > CI/CD > Exécuteurs.
- Sélectionner Nouveau runner.
- Choisissez les tâches qu’il doit prendre en charge :
- Balises: les tâches avec
tags:Ne s’exécute que sur les exécuteurs qui disposent de toutes ces options. - Exécuter les tâches non balisées: indique s’il accepte également les tâches sans balises.
- Protégé: n’exécute que les tâches des branches et des balises protégées.
- Balises: les tâches avec
- Sélectionner Créer un exécuteur et copiez le jeton. Il n’est affiché qu’une seule fois.
Traitez le jeton comme un mot de passe. Toute personne qui en dispose peut s’approprier vos tâches.
2. Enregistrer la machine
Section intitulée « 2. Enregistrer la machine »La méthode la plus simple, dans un terminal sur la machine :
champrep-code-runner register --url https://code.champrep.comLe runner demande le jeton (sans l’afficher) et l’exécuteur. Il vérifie le jeton, puis enregistre le runner dans son fichier de configuration.
Pour automatiser cette opération, transmettez le jeton via l’entrée standard ou à partir d’un fichier, afin qu’il n’ apparaisse jamais dans l’historique de votre shell ni dans la liste des processus :
printf '%s\n' "$RUNNER_TOKEN" | champrep-code-runner register \ --url https://code.champrep.com --token-stdin \ --name build-01 --executor shellchamprep-code-runner register --url https://code.champrep.com \ --token-file /root/runner-token --executor docker --docker-image alpine:3.24Sous Windows, à partir d’une invite de commande PowerShell avec privilèges élevés :
$env:RUNNER_TOKEN | champrep-code-runner.exe register ` --url https://code.champrep.com --token-stdin --name win-build-01 ` --executor shell --shell pwsh
Options courantes
Section intitulée « Options courantes »| Option | Signification |
|---|---|
--url | Votre adresse CodeCHAMPREP, par exemple https://code.champrep.com. |
--token-stdin / --token-file PATH | Lire le jeton à partir de l’entrée standard ou d’un fichier. |
--name NAME | Le nom du runner sur cette machine (par défaut : le nom de l’hôte). |
--executor | shell, docker ou kubernetes. |
--shell | Pour l’exécuteur shell : bash, sh, pwsh ou powershell. |
--docker-image IMAGE | Image de travail par défaut pour les exécuteurs Docker et Kubernetes. |
--kubernetes-namespace NS | Exécuter les tâches Kubernetes dans cet espace de noms. |
--limit N | Au maximum N tâches simultanées pour ce runner. |
--non-interactive | Ne jamais demander de confirmation ; signaler un échec si une valeur manque. |
--config PATH | Utilisez ce fichier de configuration (voir ci-dessous). |
CHPCODE_RUNNER_URL et CHPCODE_RUNNER_TOKEN peut remplacer --url et les options de jeton.
Où la configuration est-elle enregistrée ?
Section intitulée « Où la configuration est-elle enregistrée ? »| Lorsque vous l’exécutez en tant que | Fichier |
|---|---|
| root (Linux, macOS) | /etc/champrep-runner/config.toml |
| Une invite de commande avec privilèges ou le service (Windows) | %ProgramData%\champrep-runner\config.toml |
| Tout autre utilisateur | ~/.champrep-runner/config.toml |
CHPCODE_RUNNER_CONFIG ou --config choisissez un autre fichier. Le fichier est créé en lecture seule pour son propriétaire. Une machine peut héberger plusieurs runners : inscrivez-vous à nouveau avec un autre --name.
3. Démarrez-le
Section intitulée « 3. Démarrez-le »champrep-code-runner run # in this terminalchamprep-code-runner service install # or as a service that starts at bootVoir Commandes du runner pour vérifier son état, l’arrêter, etc.