github-runner docs: Managing resource usage

Managing resource usage

The charm can be hardware intensive, as each instance of self-hosted runner application is hosted in a virtual machine.

Virtual machine resource usage

The minimum requirements for a single virtual machine are:

Juju machine resource usage

It is recommended the juju machine has a minimum of 4GiB of memory dedicated to itself. Generally, 20GiB of disk is provisioned for the juju machine for the Juju logs.

The juju machine will also need the enough resources to host the virtual machines.

The recommended combined resource usage is:

  • vCPU: Depends on the workload
  • memory: number of virtual machines * (memory per virtual machine + disk per virtual machine) + 4GiB
  • disk: 20GiB

If memory is used as runner storage:

  • memory: number of virtual machines * (memory per virtual machine + disk per virtual machine) + 4GiB

Juju machine constraints

During deployment of the charm, constraints can be used to specify the juju machine resource requirements. For example, juju deploy github-runner --constraints="cores=4 mem=16G disk=20G".