Ir al contenido
Documentation

Comandos de Runner Farm

champrep runner-farm, o su alias abreviado champrep rf, gestiona CHAMPREP Runner Farm desde su terminal: sus cuentas de la granja, las conexiones del host de código, los grupos de ejecutores y sus clases de máquina, los créditos y los minutos que ha utilizado, y los trabajos que ha ejecutado la granja. Actúa en su nombre, con su inicio de sesión habitual CLI , por lo que su rol en la cuenta y su plan se aplican exactamente igual que en la aplicación web de Runner Farm.

  1. Instale el CLI y iniciar sesión con champrep auth login.
  2. Su plan debe incluir Runner Farm, y el espacio de trabajo necesita una cuenta de la granja . Cree la cuenta y añada conexiones en la aplicación web de Runner Farm en https://runners.champrep.com.

Puede actuar en más de una cuenta de la granja: la suya propia, la de una organización o la de un equipo. Enumérelas y, a continuación, seleccione una con --workspace:

Ventana de terminal
champrep rf accounts ls
champrep rf pools ls --workspace organization:65f0c0ffee0000000000abcd

--workspace toma el KEY columna de accounts ls: personal, organization:<id> o team:<id>. Sin este parámetro, la granja selecciona la cuenta de la misma forma que lo hace la aplicación web: la cuenta de su organización o de su equipo cuando disponga de una; en caso contrario, la suya propia.

ComandoObjetivo
champrep rf accounts lsEnumere los entornos de trabajo en los que puede actuar, su rol y si cada uno dispone de una cuenta de granja.
champrep rf accounts showMostrar la cuenta de la granja: estado, a quién se factura, trabajos simultáneos y el límite de crédito mensual.
champrep rf connections lsEnumere las conexiones del host de código con su estado y los trabajos en ejecución, retenidos y agrupados. --include-deleted, --limit (1-100).
champrep rf pools lsEnumere los grupos con clase de máquina, ranuras ocupadas, trabajos en espera y retenidos. --connection ID, --state active|paused|draining|deleted, --search, --include-deleted, --limit (1-200).
champrep rf pools show POOL_IDMostrar un grupo, sus límites, el tiempo de espera y las cifras correspondientes al ciclo actual.
champrep rf pools createAñada un grupo a una conexión. Requiere --connection, --name y --class; también --isolation, --max-concurrent, --min-idle, --timeout.
champrep rf pools update POOL_IDModificar --name, --max-concurrent, --min-idle o --timeout, o --pause / --resume el grupo.
champrep rf usageCréditos para el periodo de facturación actual (incluidos, comprados, utilizados, restantes) y minutos y créditos por clase de máquina para este mes o --period YYYY-MM.
champrep rf jobs lsEnumerar trabajos, empezando por los más recientes, incluidos los que están en espera, retenidos y rechazados. --state running,held, --pool ID, --billed-to-me, --limit (1-200).

OpciónValores
--classcpu-2, cpu-4, cpu-8, arm64-2, arm64-4, build-4
--isolationshared_hardened (por defecto) o tenant_dedicated
--max-concurrentTrabajos simultáneos, de 0 a 500
--min-idleTrabajos en espera mantenidos listos, de 0 a 50
--timeoutTiempo de espera del trabajo de 15m hasta 6h, por ejemplo 90m o 2h

Su plan determina qué clases, niveles de aislamiento y límites puede utilizar. Un grupo que haya superado los límites del plan tras una rebaja de categoría muestra above plan en pools ls.

Compruebe dónde se ejecutan sus trabajos y cuál es el nivel de ocupación de los grupos:

Ventana de terminal
champrep rf connections ls
champrep rf pools ls
champrep rf pools show pol_01HZX9K4

Añada un grupo para la creación de imágenes y póngalo en pausa para su mantenimiento:

Ventana de terminal
champrep rf pools create --connection con_01HZX7 --name Builds \
--class build-4 --max-concurrent 4 --timeout 2h --yes
champrep rf pools update pol_01HZX9K4 --pause --yes
champrep rf pools update pol_01HZX9K4 --resume --max-concurrent 8 --yes

Compruebe lo que ha utilizado durante este periodo y el mes pasado:

Ventana de terminal
champrep rf usage
champrep rf usage --period 2026-10

Busque trabajos que estén en espera o retenidos:

Ventana de terminal
champrep rf jobs ls --state waiting,held

pools create y pools update preguntan antes de realizar cualquier cambio. Responda y en un terminal, o pase --yes (-y) en un script. Sin un terminal y sin --yes el comando se rechaza y no modifica nada. pools create lleva una clave de idempotencia, por lo CLIque el reintento automático de tras un error de red nunca suma dos grupos.

Añadir --json para mostrar lo que ha devuelto Runner Farm. usage --json imprime { "balance": …, "usage": …, "period": "YYYY-MM" }.

Ventana de terminal
champrep rf pools ls --json | jq -r '.pools[] | "\(.id) \(.state) \(.busy)/\(.max_concurrent)"'

Las cifras de créditos dependen de su rol: los propietarios y los gestores de facturación siempre las ven; los administradores y los miembros solo las ven cuando la cuenta les muestra créditos. Las cifras ocultas se muestran como -.

Por motivos de seguridad, el CLI no puede acceder a nada que emita, sustituya o compruebe una credencial. Utilice la aplicación web de Runner Farm para:

  • crear una cuenta de granja o trasladar una a una organización;
  • añada una conexión, empareje un CHAMPREPCódigo autogestionado o sustituya un token de runner o un secreto de conector;
  • eliminan o restauran conexiones y grupos, cierran la cuenta y modifican la configuración de visibilidad de costes.

MensajeQué hacer
payment required … (INSUFFICIENT_CREDITS)El saldo no es suficiente para pagar la clase de máquina. Adquiera créditos o espere al siguiente periodo; el CLI sugiere CHAMPREP Facturación. Código de salida 1.
payment required … (PENDING_INVOICE), (WORKSPACE_NOT_BILLED)La cuenta tiene una factura pendiente de pago o su plan ha caducado. Un propietario o un gestor de facturación lo resolverá en CHAMPREP«Facturación».
needs your web session … (INTERACTIVE_SESSION_REQUIRED)Solo usted, una vez que haya iniciado sesión en la aplicación web, puede tomar esta decisión. Hágalo en https://runners.champrep.com.
not allowed for your role … (ROLE_REQUIRED)Su rol en el espacio de trabajo no le permite realizar el cambio. Consulte a un propietario o administrador.
not allowed for your role … (WORKSPACE_NOT_AVAILABLE)--workspace indica un espacio de trabajo en el que no se encuentra. Compruebe champrep rf accounts ls.
not available to your account …Su plan no incluye Runner Farm, esta clase o este límite.
rate limited … (CAPACITY_EXHAUSTED)Todas las ranuras están ocupadas. Espere y vuelva a intentarlo; comprar créditos no sirve de nada.
not found …No existe tal grupo ni conexión en esta cuenta, o el espacio de trabajo aún no dispone de una cuenta de granja.

Estos rechazos finalizan con el código 1, también con --json. rate limited (CAPACITY_EXHAUSTED) finaliza 5; consulte los códigos de salida.