Skip to main content

Runner Store

The runner store provides the machine for the execution of projects. This document describes how to use the runner store to run workflows.

Overview

The runner store provides information on all of BeetleboxCI's provided runners. A runner is a container used to run a job. Each runner is designed to run specific FPGA design environments, ensuring that they have resources and relevant tools. Using the runner store allows you to:

  • Find out the name of runners to use in workflows.
  • Find the installed applications on runners.
  • Choosing the runners with the correct CPUs and memory for the task.

runner-store-1

Using runners in workflows

To use runners in workflows, you must provide the runner name as an image within your config.yaml file. In the following example, the ubuntu-generic is first located in the runner store and the used in the config file through the image key.

runner-store-2

runners:
example-runner:
image: ubuntu-generic