From 5d0132ad2fa379d8ff76e99eeb5e8f107d5d385c Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Thu, 25 Sep 2025 11:03:09 -0400 Subject: [PATCH] docs: Add a man page for system-reinstall-bootc This is an important gap. Signed-off-by: Colin Walters --- contrib/packaging/bootc.spec | 2 +- docs/src/man/system-reinstall-bootc.8.md | 50 ++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 docs/src/man/system-reinstall-bootc.8.md diff --git a/contrib/packaging/bootc.spec b/contrib/packaging/bootc.spec index 9b9e338f1..1e5c10ecd 100644 --- a/contrib/packaging/bootc.spec +++ b/contrib/packaging/bootc.spec @@ -159,7 +159,7 @@ find %{?buildroot}/%{_docdir} ! -type d -printf '%{_docdir}/%%P\n' > bootcdoclis %{_prefix}/libexec/libostree/ext/* %endif %{_unitdir}/* -%{_mandir}/man*/bootc* +%{_mandir}/man*/*bootc* %files -n system-reinstall-bootc %{_bindir}/system-reinstall-bootc diff --git a/docs/src/man/system-reinstall-bootc.8.md b/docs/src/man/system-reinstall-bootc.8.md new file mode 100644 index 000000000..434e5c6d5 --- /dev/null +++ b/docs/src/man/system-reinstall-bootc.8.md @@ -0,0 +1,50 @@ +# NAME + +system-reinstall-bootc - Reinstall the current system with a bootc image + +# SYNOPSIS + +**system-reinstall-bootc** <*BOOTC_IMAGE*> + +# DESCRIPTION + +**system-reinstall-bootc** is a utility that allows you to reinstall your current system using a bootc container image. This tool provides an interactive way to replace your existing system with a new bootc-based system while preserving SSH access and making the previous root filesystem (including user data) available in `/sysroot`. + +The utility will: +- Pull the specified bootc container image +- Collect SSH keys for root access after reinstall +- Execute a bootc install to replace the current system +- Reboot into the new system + +After reboot, the previous root filesystem will be available in `/sysroot`, and some automatic cleanup of the previous root will be performed. Note that existing mounts will not be automatically mounted by the bootc system unless they are defined in the bootc image. + +This is primarily intended as a way to "take over" cloud virtual machine images, effectively using them as an installer environment. + +# ARGUMENTS + +**BOOTC_IMAGE** + + The bootc container image to install (e.g., quay.io/fedora/fedora-bootc:41) + + This argument is required. + +# EXAMPLES + +Reinstall with a custom bootc image: +``` +system-reinstall-bootc registry.example.com/my-bootc:latest +``` + +# ENVIRONMENT + +**BOOTC_REINSTALL_CONFIG** + + This variable is deprecated. + +# SEE ALSO + +**bootc**(8), **bootc-install**(8) + +# VERSION + +