Skip to content

Commit 5d0132a

Browse files
committed
docs: Add a man page for system-reinstall-bootc
This is an important gap. Signed-off-by: Colin Walters <[email protected]>
1 parent 788162f commit 5d0132a

File tree

2 files changed

+51
-1
lines changed

2 files changed

+51
-1
lines changed

contrib/packaging/bootc.spec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ find %{?buildroot}/%{_docdir} ! -type d -printf '%{_docdir}/%%P\n' > bootcdoclis
159159
%{_prefix}/libexec/libostree/ext/*
160160
%endif
161161
%{_unitdir}/*
162-
%{_mandir}/man*/bootc*
162+
%{_mandir}/man*/*bootc*
163163

164164
%files -n system-reinstall-bootc
165165
%{_bindir}/system-reinstall-bootc
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# NAME
2+
3+
system-reinstall-bootc - Reinstall the current system with a bootc image
4+
5+
# SYNOPSIS
6+
7+
**system-reinstall-bootc** <*BOOTC_IMAGE*>
8+
9+
# DESCRIPTION
10+
11+
**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`.
12+
13+
The utility will:
14+
- Pull the specified bootc container image
15+
- Collect SSH keys for root access after reinstall
16+
- Execute a bootc install to replace the current system
17+
- Reboot into the new system
18+
19+
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.
20+
21+
This is primarily intended as a way to "take over" cloud virtual machine images, effectively using them as an installer environment.
22+
23+
# ARGUMENTS
24+
25+
**BOOTC_IMAGE**
26+
27+
The bootc container image to install (e.g., quay.io/fedora/fedora-bootc:41)
28+
29+
This argument is required.
30+
31+
# EXAMPLES
32+
33+
Reinstall with a custom bootc image:
34+
```
35+
system-reinstall-bootc registry.example.com/my-bootc:latest
36+
```
37+
38+
# ENVIRONMENT
39+
40+
**BOOTC_REINSTALL_CONFIG**
41+
42+
This variable is deprecated.
43+
44+
# SEE ALSO
45+
46+
**bootc**(8), **bootc-install**(8)
47+
48+
# VERSION
49+
50+
<!-- VERSION PLACEHOLDER -->

0 commit comments

Comments
 (0)