Blueprint Reference
Blueprints are text files in the TOML format that describe customizations for the image you are building. To be used in the π΅Β onΒ premises environment.
Analogously the request content of the
image-builder /compose
request
describes customizations of an image the π€Β hosted service should be building.
Not all customizations are supported in the API but those existing, are highlighted here with a
π€Β hosted label.
An important thing to note is that these customizations are not applicable to all image types.
osbuild-composer
currently has no good validation or warning system in place to tell you if a customization in your blueprint is not supported for the image type you're building. The customization may be silently dropped.
A very basic blueprint with just the required attributes at the root looks like:
- π΅ on premises
- π€ hosted
name = "basic-example"
description = "A basic blueprint"
version = "0.0.1"
{
"image_name": "basic-example",
"image_description": "A basic blueprint"
}
Where:
- The
name
attribute is a string that contains the name of the blueprint. It can contain spaces, but they will be converted to-
when it is imported intoosbuild-composer
. It should be short and descriptive. - The
description
attribute is a string that can be a longer description of the blueprint and is only used for display purposes. - The
version
attribute is a string that contains a semantic versioning compatible version number. If a new blueprint is uploaded with the same version the server will automatically bump the PATCH level of the version. If the version doesn't match it will be used as is. For example, uploading a blueprint with version set to 0.1.0 when the existing blueprint version is 0.0.1 will result in the new blueprint being stored as version 0.1.0.
You can upload a blueprint with the osbuild-composer blueprints push $filename
command, the blueprint will then be usable in osbuild-composer compose
as the name
you gave it.
Blueprints have two main sections, the content and customizations sections.