Agents

Runners

A runner is the program that does the work: it takes runs from the queue, runs their steps on its machine, and reports back. Install as many as you like, on laptops, servers, Docker or Kubernetes, from the Runners page.

#Pairing

A runner on a desktop opens the SpudSuite Runner app, where you sign in and pick this workspace. A runner on a server prints a short code and a link; a workspace admin opens the link and approves it. For Docker and Kubernetes, a workspace admin makes a registration token, which lets runners join without anyone approving a code. Revoke the token when you no longer need it.

#Labels

Each runner has labels, such as gpu, linux or prod. A run that asks for labels (with runner_labels when it starts) only goes to a runner that has them all. The assistant can be limited to runners with certain labels too.

#Secrets

Secrets live on the runner, in its own store, and are never sent to SpudSuite. Workflows refer to them by name (secrets.<name>), and Gateway and Connection resources name the secret that holds their key. Set them in the runner app, or with the runner's command line on a server.

#Capacity and leases

A runner takes up to its capacity of runs at once. While it works on a run it holds a lease and renews it as it reports. If it stops reporting, for example because the machine went to sleep, the lease runs out and the run is marked lost.