Skip to content

Fix docs for FIPS, btrfs, partitioning_mode - #210

Merged
schuellerf merged 4 commits into
osbuild:mainfrom
schuellerf:fix-docs
Jul 31, 2026
Merged

Fix docs for FIPS, btrfs, partitioning_mode#210
schuellerf merged 4 commits into
osbuild:mainfrom
schuellerf:fix-docs

Conversation

@schuellerf

Copy link
Copy Markdown
Contributor

based on #209
fixes docs for FIPS, btrfs and partitioning_mode

especially the partitioning_mode needs a review if this is better now…
in the custom_repositories json, I think there only was a typo.

setting to draft so we can merge them in-order.

@schuellerf
schuellerf force-pushed the fix-docs branch 2 times, most recently from ff41712 to f5c9d82 Compare July 31, 2026 09:01
@schuellerf
schuellerf marked this pull request as ready for review July 31, 2026 09:03
@schuellerf
schuellerf requested a review from a team as a code owner July 31, 2026 09:03
FIPS is no longer Edge-only; point readers at per-type supported_options
in the image descriptions.
Align the partitioning_mode list with the Partitioning guide, which
already describes btrfs alongside auto-lvm, raw, and lvm.
The array elements must be objects; the previous example was invalid
JSON and would fail if copied into a compose request.
State both cases directly instead of an "unless" phrasing.
@schuellerf
schuellerf enabled auto-merge (rebase) July 31, 2026 09:26
@schuellerf
schuellerf requested a review from achilleas-k July 31, 2026 09:40

@achilleas-k achilleas-k left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers. LGTM.
Small note, but up to you.

- `auto-lvm` (default) uses raw unless [filesystem customizations](#filesystems) are included, in which case it uses LVM.
- `raw` always uses raw partitions
- `lvm` always uses LVM partitions
- `btrfs` converts the root partition to a Btrfs volume (extra mountpoints become subvolumes; see [Partitioning](./07-partitioning.md))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention that it's not supported on CentOS and RHEL (except if building with a custom kernel that supports it?) or should we expect that people will know?

@schuellerf schuellerf Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I usually expect all sorts of people reading our docs, so sure, I'll add a hint for this, makes sense!
(in the next PR :-D )

@schuellerf
schuellerf merged commit 3118891 into osbuild:main Jul 31, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants