Using the Runner in GitHub Actions
Once the runner configuration is created, a label is assigned to the runners, which can be found in the configuration details. To use this runner in a GitHub Action workflow, include the assigned label in the “runs-on” field of the GitHub Action YAML definition.
Cloud Configuration
This setting allows additional dependencies to be installed on created servers using the standard cloud-init format.
Budget
The system tracks monthly usage, and once it exceeds the defined budget, no new runners will be created, and existing ones will be shut down.
Maximum Runners
This value defines the maximum number of runners that can be created, ensuring the total active runners never exceed this limit.
Minimum Runners
Minimum runners ensure that a set number of runners remain active at all times. If specified, at least this many runners will always be available. If not, idle runners will be terminated after a set period of inactivity.
Additional Configuration Options
You can define the following optional settings:
Configuration Setup
On the Create Configuration screen, select the appropriate server architecture and settings. This configuration will be used to deploy servers.
Runner Configuration
To create a runner configuration, go to the “Configuration” tab and click the “Add New Configuration” button.
Guide to Configuring Cirox Runners
Only GitHub organization owners can sign in and install the Cirox app into their organization. Once signed in, they will be redirected to Cirox to configure runners.
After registering the GitHub app with your organization, you need to create a runner configuration to use Cirox runners in the CI/CD pipeline.
In This Page