From 4ce28ae5443167b87111c56b049f622114a229ee Mon Sep 17 00:00:00 2001 From: Irene Diez Date: Tue, 29 Nov 2022 18:24:32 +0100 Subject: [PATCH] blueprint-reference: add Ignition config section Signed-off-by: Irene Diez --- .../blueprint-reference.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/osbuild-composer/src/blueprint-reference/blueprint-reference.md b/osbuild-composer/src/blueprint-reference/blueprint-reference.md index 80a0f073..f118db56 100644 --- a/osbuild-composer/src/blueprint-reference/blueprint-reference.md +++ b/osbuild-composer/src/blueprint-reference/blueprint-reference.md @@ -154,6 +154,7 @@ In the customizations we determine what goes into the image that's not in the de - [Files and Directories](#files-and-directories) - [Directories](#directories) - [Files](#files) +- [Ignition](#ignition) - [Repositories](#repositories) - [Filesystems](#filesystems) - [OpenSCAP](#openscap) @@ -413,6 +414,30 @@ data = "Hello world!" Note that the `data` property can be specified in any of the ways supported by TOML. Some of them require escaping certain characters and others don't. Please refer to the [TOML specification](https://toml.io/en/v1.0.0#string) for more details. +### Ignition + +The `customizations.ignition` section allows users to provide [Ignition](https://coreos.github.io/ignition/) configuration files to be used in `edge-raw-image` and `edge-simplified-installer` images. Check the RHEL for Edge (`r4e`) [butane](https://coreos.github.io/butane/specs/) specification for a description of the supported configuration options. + +The blueprint configuration can be done *either* by embedding an Ignition configuration file into the image (only available for `edge-simplified-installer`), or providing a provisioning URL that will be fetched at first boot. + +#### `ignition.embedded` configuration + +```toml +[customizations.ignition.embedded] +config = "eyJpZ25pdGlvbiI6eyJ2ZXJzaW9uIjoiMy4zLjAifSwicGFzc3dkIjp7InVzZXJzIjpbeyJncm91cHMiOlsid2hlZWwiXSwibmFtZSI6ImNvcmUiLCJwYXNzd29yZEhhc2giOiIkNiRqZnVObk85dDFCdjdOLjdrJEhxUnhxMmJsdFIzek15QUhqc1N6YmU3dUJIWEVyTzFZdnFwaTZsamNJMDZkUUJrZldYWFpDdUUubUpja2xQVHdhQTlyL3hwSmlFZFdEcXR4bGU3aDgxIn1dfX0=" +``` + +Add a `base64` encoded Ignition configuration in the `config` field. This Ignition configuration will be included in the `edge-simplified-installer` image. + +#### `ignition.firstboot` configuration + +```toml +[customizations.ignition.firstboot] +url = "http://some-server/configuration.ig" +``` + +Add a URL pointing to the Ignition configuration that will be fetched during the first boot in the `url` field. Available for both `edge-simplified-installer` and `edge-raw-image`. + ### Repositories Third-party repositories are supported by the blueprint customizations. A repository can be defined and enabled in the blueprints which will then be saved to the `/etc/yum.repos.d` directory in an image.