-
Notifications
You must be signed in to change notification settings - Fork 149
docs: Add a man page for bootc-root-setup #1767
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
cgwalters
wants to merge
1
commit into
bootc-dev:main
Choose a base branch
from
cgwalters:manpage-bootc-setup-root
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # NAME | ||
|
|
||
| bootc-root-setup.service | ||
|
|
||
| # DESCRIPTION | ||
|
|
||
| This service runs in the initramfs to set up the root filesystem when composefs is enabled. | ||
| It is only activated when the `composefs` kernel command line parameter is present. | ||
|
|
||
| The service performs the following operations: | ||
|
|
||
| - Mounts the composefs image specified in the kernel command line | ||
| - Sets up `/etc` and `/var` directories from the deployment state | ||
| - Optionally configures transient overlays based on the configuration file | ||
| - Prepares the root filesystem for switch-root | ||
|
|
||
| This service runs after `sysroot.mount` and `ostree-prepare-root.service`, and before | ||
| `initrd-root-fs.target`. | ||
|
|
||
| # CONFIGURATION FILE | ||
|
|
||
| The service reads an optional configuration file at `/usr/lib/composefs/setup-root-conf.toml`. | ||
| If this file does not exist, default settings are used. | ||
|
|
||
| **WARNING**: The configuration file format and composefs integration are experimental | ||
| and subject to change. | ||
|
|
||
| ## Configuration Options | ||
|
|
||
| The configuration file uses TOML format with the following sections: | ||
|
|
||
| ### `[root]` | ||
|
|
||
| - `transient` (boolean): If true, mounts the root filesystem as a transient overlay. | ||
| This makes all changes to `/` ephemeral and lost on reboot. Default: false. | ||
|
|
||
| ### `[etc]` | ||
|
|
||
| - `mount` (string): Mount type for `/etc`. Options: "none", "bind", "overlay", "transient". | ||
| Default: "bind". | ||
| - `transient` (boolean): Shorthand for `mount = "transient"`. Default: false. | ||
|
|
||
| ### `[var]` | ||
|
|
||
| - `mount` (string): Mount type for `/var`. Options: "none", "bind", "overlay", "transient". | ||
| Default: "bind". | ||
| - `transient` (boolean): Shorthand for `mount = "transient"`. Default: false. | ||
|
|
||
| ## Example Configuration | ||
|
|
||
| ```toml | ||
| [root] | ||
| transient = false | ||
|
|
||
| [etc] | ||
| mount = "bind" | ||
|
|
||
| [var] | ||
| mount = "overlay" | ||
| ``` | ||
|
|
||
| # EXPERIMENTAL STATUS | ||
|
|
||
| The composefs integration, including this service and its configuration file format, | ||
| is experimental and subject to change. | ||
|
|
||
| # SEE ALSO | ||
|
|
||
| **bootc(8)** | ||
cgwalters marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| # VERSION | ||
|
|
||
| <!-- VERSION PLACEHOLDER --> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.