Configuration

Beside the keys every provider has, a proxmox provider reads these.

url

string

url is where the cluster’s API is: any of its nodes, https://pve.example.com:8006. Unset port is 8006. It is required.

token_id

string

token_id is the API token Rungar authenticates with, as USER@REALM!NAME. Its privileges are on the provider’s page. It is required.

token_secret

string

token_secret is the token’s secret. token_secret_path is a file holding it instead, which keeps it out of this file. Give one or the other.

token_secret_path

string

See token_secret, above.

nodes

list of strings

nodes are the cluster’s nodes runners may be placed on. Unset is every online node.

timeout

duration, such as 30s or 5m

timeout bounds one call to the API. Creating a runner, which clones and boots a VM, is bounded by the scale set’s start_timeout instead. Unset is 10s.

tls

mapping

tls is how the API’s certificate is verified. Unset uses this machine’s root CAs.

tls.ca_file

string

ca_file holds the PEM authorities the API’s certificate is checked against: the cluster’s own, /etc/pve/pve-root-ca.pem, for a certificate Proxmox VE made itself.

tls.insecure_skip_verify

boolean

insecure_skip_verify accepts any certificate, which lets whoever is between Rungar and the API read the token. For a test cluster only.

runner

mapping

The keys of a runner block, the provider’s and each scale set’s for it: a runner is a VM cloned from a template.

runner.template

integer

template is the VMID of the template runners are cloned from. It must run the QEMU guest agent, and start the Actions runner with the registration Rungar writes to jit_path; see Preparing a template. It is required.

runner.cores

integer

cores is how many CPU cores the VM has. It is required.

runner.memory

size, such as 512MiB or 4GiB

memory is the VM’s memory, written as a size: 4GiB. It is required, at least 128MiB, and a whole number of MiB.

runner.full_clone

boolean

full_clone copies the template’s disks, rather than making a linked clone that shares them. A linked clone is quick, and needs the template’s storage to support it. Unset is false.

runner.storage

string

storage is where a full clone’s disks go. Unset is the template’s storage. Only for a full clone.

runner.pool

string

pool is the resource pool runners are put in. Unset is none.

runner.jit_path

string

jit_path is the file in the VM the runner’s registration is written to, through the guest agent, once it answers. Unset is /run/rungar/jitconfig.