Skip to main content

Images

An image is a compressed package that contains the settings and the file system to spawn a runner (container) in order to run a job. The user declares the image to use for a job in the .bbx/config.yaml file. This document describes how to use images to create runners to run pipelines.

BeetleboxCI includes a registry to store images locally and BeetleboxCI has the capability to use both local and remote images when running pipelines.

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.

images

Setting up runners in workflows

To use images to set up 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 image registry and the used in the config file through the image key.

runners:
example-runner:
image: ubuntu-generic