Commandes Runner Farm
champrep runner-farm, ou son alias court champrep rf, gère CHAMPREP Runner Farm depuis votre terminal : vos comptes de ferme, les connexions à l’hôte de code, les pools de runners et leurs classes de machines, les crédits et les minutes que vous avez utilisés, ainsi que les tâches exécutées par la ferme. Il agit en votre nom, avec vos identifiants de connexion habituels CLI ; ainsi, votre rôle au sein du compte et votre forfait s’appliquent exactement comme dans l’application web Runner Farm.
Avant de commencer
Section intitulée « Avant de commencer »- Installez le CLI et se connecter avec
champrep auth login. - Votre forfait doit inclure Runner Farm, et l’espace de travail nécessite un compte de ferme . Créez le compte et ajoutez des connexions dans l’application web Runner Farm à l’adresse
https://runners.champrep.com.
Quel compte de ferme
Section intitulée « Quel compte de ferme »Vous pouvez agir sur plusieurs comptes de ferme : le vôtre, celui d’une organisation ou celui d’une équipe. Répertoriez-les, puis choisissez-en un avec --workspace:
champrep rf accounts lschamprep rf pools ls --workspace organization:65f0c0ffee0000000000abcd--workspace prend la KEY colonne de accounts ls: personal,
organization:<id> ou team:<id>. En l’absence de cette indication, la ferme sélectionne le compte de la même manière que l’application web : le compte de votre organisation ou de votre équipe lorsqu’il en existe un, sinon votre propre compte.
Commandes
Section intitulée « Commandes »| Commande | Objectif |
|---|---|
champrep rf accounts ls | Répertoriez les espaces de travail dans lesquels vous pouvez intervenir, votre rôle, et indiquez si chacun dispose d’un compte de ferme. |
champrep rf accounts show | Afficher le compte de la ferme : statut, destinataire de la facturation, nombre de tâches simultanées et plafond de crédit mensuel. |
champrep rf connections ls | Répertoriez les connexions de l’hôte de code avec leur état et les tâches en cours d’exécution, en attente et mises en pool. --include-deleted, --limit (1-100). |
champrep rf pools ls | Liste des pools avec classe de machine, emplacements occupés, tâches en attente et mises en attente. --connection ID, --state active|paused|draining|deleted, --search, --include-deleted, --limit (1-200). |
champrep rf pools show POOL_ID | Afficher un pool, ses limites, son délai d’expiration et ses chiffres pour le cycle en cours. |
champrep rf pools create | Ajouter un pool à une connexion. Nécessite --connection, --name et --class; également --isolation, --max-concurrent, --min-idle, --timeout. |
champrep rf pools update POOL_ID | Modifier --name, --max-concurrent, --min-idle ou --timeout, ou --pause / --resume le pool. |
champrep rf usage | Crédits pour la période de facturation en cours (inclus, achetés, utilisés, restants) et minutes et crédits par classe de machine pour ce mois-ci ou --period YYYY-MM. |
champrep rf jobs ls | Liste des travaux, les plus récents en premier, y compris ceux en attente, suspendus et refusés. --state running,held, --pool ID, --billed-to-me, --limit (1-200). |
Classes de machines et limites
Section intitulée « Classes de machines et limites »| Option | Valeurs |
|---|---|
--class | cpu-2, cpu-4, cpu-8, arm64-2, arm64-4, build-4 |
--isolation | shared_hardened (par défaut) ou tenant_dedicated |
--max-concurrent | Tâches simultanées, de 0 à 500 |
--min-idle | Tâches en attente maintenues prêtes, de 0 à 50 |
--timeout | Délai d’expiration des tâches de à 15m à 6h, par exemple 90m ou 2h |
Votre forfait détermine les classes, les niveaux d’isolation et les limites que vous êtes autorisé à utiliser. Un pool qui a dépassé les limites du forfait après un déclassement affiche above plan dans
pools ls.
Exemples
Section intitulée « Exemples »Vérifiez où vos tâches s’exécutent et le taux d’occupation des pools :
champrep rf connections lschamprep rf pools lschamprep rf pools show pol_01HZX9K4Ajoutez un pool pour la création d’images et mettez-le en pause pour maintenance :
champrep rf pools create --connection con_01HZX7 --name Builds \ --class build-4 --max-concurrent 4 --timeout 2h --yeschamprep rf pools update pol_01HZX9K4 --pause --yeschamprep rf pools update pol_01HZX9K4 --resume --max-concurrent 8 --yesVérifiez ce que vous avez utilisé au cours de cette période et le mois dernier :
champrep rf usagechamprep rf usage --period 2026-10Rechercher les tâches en attente ou suspendues :
champrep rf jobs ls --state waiting,held
Confirmation et scripts
Section intitulée « Confirmation et scripts »pools create et pools update demandent votre accord avant d’effectuer toute modification. Répondez y
sur un terminal, ou transmettez --yes (-y) dans un script. Sans terminal et sans --yes la commande échoue et ne modifie rien. pools create
comporte une clé d’idempotence ; ainsi, la nouvelle tentative automatique CLIde après une erreur réseau n’ajoute jamais deux pools.
Ajouter --json pour afficher la réponse renvoyée par Runner Farm. usage --json affiche
{ "balance": …, "usage": …, "period": "YYYY-MM" }.
champrep rf pools ls --json | jq -r '.pools[] | "\(.id) \(.state) \(.busy)/\(.max_concurrent)"'Les montants de crédits dépendent de votre rôle : les propriétaires et les responsables de la facturation les voient toujours ; les administrateurs et les membres ne les voient que lorsque le compte leur attribue des crédits. Les montants masqués s’affichent sous la forme -.
Ce qui reste dans l’application web
Section intitulée « Ce qui reste dans l’application web »Pour des raisons de sécurité, le CLI ne peut accéder à aucun élément qui émet, remplace ou teste un identifiant. Utilisez l’application web Runner Farm pour :
- créer un compte de ferme ou en transférer un vers une organisation ;
- ajouter une connexion, associer un CodeCHAMPREP autogéré, ou remplacer un jeton de runner ou un secret de connecteur ;
- permettent de supprimer ou de restaurer des connexions et des pools, de fermer le compte et de modifier le paramètre de visibilité des coûts.
Erreurs que vous pourriez rencontrer
Section intitulée « Erreurs que vous pourriez rencontrer »| Message | Que faire ? |
|---|---|
payment required … (INSUFFICIENT_CREDITS) | Le solde est insuffisant pour payer la classe de machine. Achetez des crédits ou attendez la prochaine période ; le CLI suggère de consulter la section FacturationCHAMPREP. Code de sortie 1. |
payment required … (PENDING_INVOICE), (WORKSPACE_NOT_BILLED) | Le compte présente une facture impayée ou son forfait a pris fin. Un propriétaire ou un responsable de la facturation doit régulariser la situation dans la section « FacturationCHAMPREP ». |
needs your web session … (INTERACTIVE_SESSION_REQUIRED) | Vous seul, connecté à l’application web, pouvez prendre cette décision. Effectuez cette opération à l’adresse https://runners.champrep.com. |
not allowed for your role … (ROLE_REQUIRED) | Votre rôle dans l’espace de travail ne vous autorise pas à effectuer cette modification. Veuillez vous adresser à un propriétaire ou à un administrateur. |
not allowed for your role … (WORKSPACE_NOT_AVAILABLE) | --workspace désigne un espace de travail dont vous ne faites pas partie. Vérifiez champrep rf accounts ls. |
not available to your account … | Votre forfait ne comprend pas Runner Farm, cette classe ou cette limite. |
rate limited … (CAPACITY_EXHAUSTED) | Tous les emplacements sont occupés. Veuillez patienter et réessayer ; l’achat de crédits n’y changera rien. |
not found … | Ce pool ou cette connexion n’existe pas dans ce compte, ou l’espace de travail ne dispose pas encore de compte de ferme. |
Ces refus se terminent par le code 1, ainsi qu’avec --json. rate limited
(CAPACITY_EXHAUSTED) se termine 5; consultez le
Codes de sortie.