From bd7ee5779844458d1ff491743342a05565f53250 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Fri, 26 Apr 2024 08:06:52 -0400 Subject: [PATCH] docs: Link to bootupd in prominent places Came up in chat. Signed-off-by: Colin Walters --- docs/src/bootc-images.md | 7 +++++++ docs/src/bootc-install.md | 6 ++++++ 2 files changed, 13 insertions(+) diff --git a/docs/src/bootc-images.md b/docs/src/bootc-images.md index 3c736354..9cb74b7c 100644 --- a/docs/src/bootc-images.md +++ b/docs/src/bootc-images.md @@ -77,3 +77,10 @@ container build tool supports producing OCI container images. You may find some references to this; it is no longer very useful and is not recommended. +# The bootloader setup + +At the current time bootc relies on the [bootupd](https://github.com/coreos/bootupd/) +project which handles bootloader installs and upgrades. The invocation of +`bootc install` will always run `bootupd` to perform installations. +Additionally, `bootc upgrade` will currently not upgrade the bootloader; +you must invoke `bootupctl update`. diff --git a/docs/src/bootc-install.md b/docs/src/bootc-install.md index 30c6e3a7..b006ee1e 100644 --- a/docs/src/bootc-install.md +++ b/docs/src/bootc-install.md @@ -9,6 +9,12 @@ or virtualized), one needs a few key components: - kernel (and optionally initramfs) - root filesystem (xfs/ext4/btrfs etc.) +The bootloader state is managed by the external [bootupd](https://github.com/coreos/bootupd/) +project which abstracts over bootloader installs and upgrades. The invocation of +`bootc install` will always run `bootupd` to handle bootloader installation +to the target disk. The default expectation is that bootloader contents and install logic +come from the container image in a `bootc` based system. + The Linux kernel (and optionally initramfs) is embedded in the container image; the canonical location is `/usr/lib/modules/$kver/vmlinuz`, and the initramfs should be in `initramfs.img` in that directory.