Create and Connect a Pool
You need an organisation administrator role in Quant, and permission to install a GitHub App on your GitHub organisation.
Create a pool
Section titled “Create a pool”- Open Cloud → CI runners and choose Create pool.
- Enter a name. Use 2 to 41 lowercase letters, numbers and hyphens. Your jobs use the name as a
runs-onlabel, so keep it short, for examplebuild. The namesquant,self-hosted,arm64,x64andlinuxare reserved. - Choose a tier. The tier is a hard cap on the number of jobs that run at once. See Pool tiers.
- Choose the architectures: arm64 (Graviton), x64 (Intel), or both.
- Set the idle timeout, from 5 to 120 minutes. The pool’s machines stop when no job has run for this long. The default is 15 minutes.
- Optionally turn on Keep one VM warm in business hours and enter a timezone, a start time and an end time. One machine then stays running in that window, so the first job of the day starts without a wait.
- Choose Create pool.
The pool shows Creating for a few minutes and then Available.
Connect the pool to GitHub
Section titled “Connect the pool to GitHub”- On the pool, choose Connect it to your GitHub organisation.
- GitHub opens and asks you to install the Quant CI runners app. Choose your GitHub organisation.
- Choose All repositories or select the repositories that may use the pool, then install.
- GitHub sends you back to the dashboard, and the pool shows Connected to with your organisation’s name.
The app asks for the permissions it needs to see queued jobs and to register runners. It does not ask for a personal access token, and it cannot read your code.
Each GitHub organisation connects to one pool. To separate workloads, choose a larger tier or use both architectures.
To change which repositories may use the pool, choose Manage access on GitHub on the pool. This opens the app’s settings page in your GitHub organisation.
Keep public repositories out
Section titled “Keep public repositories out”In your GitHub organisation, open Settings → Actions → Runner groups, select the default group, and keep Allow public repositories turned off. Quant runners also refuse jobs from public repositories on their side.
Change or delete a pool
Section titled “Change or delete a pool”Choose Edit on a pool to change its tier, architectures, idle timeout or warm hours. When jobs often wait for a slot, the pool offers an Upsize shortcut to the next tier.
Choose Delete to remove a pool. Running jobs are stopped, the runners are removed and the GitHub link is removed. You cannot undo a delete.
