Skip to content
BlueBuild. A minimal logo with a blue-billed duck holding a golden wrench in its beak. BlueBuild. A minimal logo with a blue-billed duck holding a golden wrench in its beak. BlueBuild

recipe.yml

A recipe.yml file describes the build process of a custom image. The top-level keys set the metadata and base for the image, and modules are build steps that add things on top of the base.

Reference

Section titled “Reference”

name: (required)

Section titled “name: (required)”

string

The image name. Used when publishing to GHCR as ghcr.io/user/name.

description: (required)

Section titled “description: (required)”

string

The image description. Published to GHCR in the image metadata.

alt-tags[]:

Section titled “alt-tags[]:”

array of string

Allows setting custom tags on the recipe’s final image. Adding tags to this property will override the latest and timestamp tags.

base-image: (required)

Section titled “base-image: (required)”

string

The OCI image to base your custom image on. Only atomic Fedora images and those based on them are officially supported as of now. BlueBuild base images or Universal Blue images are recommended. Other custom bootc images can be used as well.

Example:

base-image: ghcr.io/blue-build/base-images/fedora-silverblue

image-version: (required)

Section titled “image-version: (required)”

enum with valid values:

  • string

  • integer

The tag of the base image to build on. Used to select a version explicitly (40) or to always use the latest stable version (latest). A list of all available tags can be viewed by pasting your base-image url into your browser.

blue-build-tag:

Section titled “blue-build-tag:”

string

The tag to pull for the BlueBuild cli. This is mostly used for trying out specific versions of the cli without compiling it locally. Supply the tag of the cli release container to pull, see the list of available tags for reference. Default: latest-installer. Set to to none to opt out of installing the CLI into your image.

cosign-version:

Section titled “cosign-version:”

string

The version of cosign that will be included in the image. This will override the default version set by the CLI. Setting to none will prevent installing cosign altogether.

nushell-version:

Section titled “nushell-version:”

string

The version of nushell to include at /usr/libexec/bluebuild/nu/nu for use by modules in the image. This will override the default BlueBuild Nushell version. Change only if you need a specific version of Nushell, changing this might break some BlueBuild modules. Set to to none to opt out of installing Nushell into your image (this will break modules that use Nushell at run time in the final image, like default-flatpaks).

platforms[]:

Section titled “platforms[]:”

array of enum with valid values:

  • linux/amd64
  • linux/amd64/v2
  • linux/arm64
  • linux/arm
  • linux/arm/v6
  • linux/arm/v7
  • linux/386
  • linux/loong64
  • linux/mips
  • linux/mipsle
  • linux/mips64
  • linux/mips64le
  • linux/ppc64
  • linux/ppc64le
  • linux/riscv64
  • linux/s390x

Specify a list of the platforms to build for your image. The resulting images will be added to a manifest list that allows your host’s container runtime to pull the correct image architecture for your hardware. The process of building a multi-architecture image will end up using emulation. Consequently, image builds will take significantly longer and more space will be required on the build host since each platform that is being built is its own image. If platforms: is not specified, the build host’s architecture will be used.

labels:

Section titled “labels:”

object

A collection of custom labels that will be applied to the image.

Each item should be a key: value pair representing a label name mapping to label value.

stages[]:

Section titled “stages[]:”

array of enum with valid values:

  • external

  • external

A list of stages that are executed before the build of the final image. This is useful for compiling programs from source without polluting the final bootable image.

modules[]: (required)

Section titled “modules[]: (required)”

array of enum with valid values:

  • external

  • external

A list of modules that is executed in order. Multiple of the same module can be included.

Each item in this list needs have at least a type: except if the configuration is included from an external file in the recipes/ directory with from-file:.

Example:

modules:
 - from-file: common-packages.yml # an external module configuration file for installing commong packages
 - type: signing # a module that doesn't require any configuration