summaryrefslogtreecommitdiff
path: root/apidoc
diff options
context:
space:
mode:
authorJonathan Lebon <jonathan@jlebon.com>2020-08-17 09:48:18 -0400
committerJonathan Lebon <jonathan@jlebon.com>2020-09-30 13:29:32 -0400
commit81b13da8e35e18cfb445f66bf365420aa0e9fa0a (patch)
tree108985e5bdc16ca7b48ae0777fd8bb6e8ffd9193 /apidoc
parent40fea4c44390116095841ee11b4d336195e56330 (diff)
downloadostree-81b13da8e35e18cfb445f66bf365420aa0e9fa0a.tar.gz
lib/deploy: Add support for overlay initrds
In FCOS and RHCOS, the need to configure software in the initramfs has come up multiple times. Sometimes, using kernel arguments suffices. Other times, it really must be a configuration file. Rebuilding the initramfs on the client-side however is a costly operation. Not only does it add complexity to the update workflow, it also erodes a lot of the value obtained from using the baked "blessed" initramfs from the tree itself. One elegant way to address this is to allow specifying multiple initramfses. This is supported by most bootloaders (notably GRUB) and results in each initrd being overlayed on top of each other. This patch allows libostree clients to leverage this so that they can avoid regenerating the initramfs entirely. libostree itself is agnostic as to what kind and how much data overlay initrds contain. It's up to the clients to enforce such boundaries. To implement this, we add a new ostree_sysroot_stage_overlay_initrd which takes a file descriptor and returns a checksum. Then users can pass these checksums when calling the deploy APIs via the new array option `overlay_initrds`. We copy these files into `/boot` and add them to the BLS as another `initrd` entry.
Diffstat (limited to 'apidoc')
-rw-r--r--apidoc/ostree-sections.txt1
1 files changed, 1 insertions, 0 deletions
diff --git a/apidoc/ostree-sections.txt b/apidoc/ostree-sections.txt
index 4ef396e6..c1d6b35e 100644
--- a/apidoc/ostree-sections.txt
+++ b/apidoc/ostree-sections.txt
@@ -548,6 +548,7 @@ ostree_sysroot_write_deployments_with_options
ostree_sysroot_write_origin_file
ostree_sysroot_stage_tree
ostree_sysroot_stage_tree_with_options
+ostree_sysroot_stage_overlay_initrd
ostree_sysroot_deploy_tree
ostree_sysroot_deploy_tree_with_options
ostree_sysroot_get_merge_deployment