Skip to content

Fix docs for FIPS, btrfs, partitioning_mode #210

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.

Sign up for GitHub

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

Merged
schuellerf merged 4 commits into from
Jul 31, 2026
Merged

Fix docs for FIPS, btrfs, partitioning_mode #210

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e717f2
blueprint-reference: fix outdated FIPS support claim
schuellerf Jul 30, 2026
a5f1718
blueprint-reference: document btrfs partitioning mode
schuellerf Jul 30, 2026
8be32e9
blueprint-reference: fix hosted custom_repositories JSON example
schuellerf Jul 30, 2026
d2b7934
blueprint-reference: clarify auto-lvm when plain vs LVM
schuellerf Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 27 additions & 17 deletions docs/user-guide/01-blueprint-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1302,12 +1302,14 @@ enabled=true
{
"customizations": {
"custom_repositories": [
"id": "example",
"name": "Example repo",
"baseurl": [ "https://example.com/yum/download" ],
"check_gpg": true,
"gpgkey" : [ "https://example.com/public-key.asc" ],
"enabled": true
{
"id": "example",
"name": "Example repo",
"baseurl": [ "https://example.com/yum/download" ],
"check_gpg": true,
"gpgkey": [ "https://example.com/public-key.asc" ],
"enabled": true
}
]
}
}
Expand Down Expand Up @@ -1346,16 +1348,23 @@ in the repository configuration. **GPG keys are not imported to the RPM database

_See the section of the guide on [Partitioning](./07-partitioning.md) for more details._

The `customizations.partitioning_mode` variable can be used to select how the
disk image will be partitioned. `auto-lvm` will use raw unless there are one or
more [filesystem customizations](#filesystems) in which case it will use LVM.
`lvm` always uses LVM, even when there are no extra mountpoints. `raw` uses raw
partitions even when there are one or more mountpoints.
The `customizations.partitioning_mode` variable controls how filesystem
customizations change the image type’s **base** partition table. The base
layout itself depends on the image type: some defaults are plain partitions,
others already use LVM (for example Fedora Server) or Btrfs.

To see a type’s default, open its [image description](./09-image-descriptions/index.md)
and inspect `partition_table` in the YAML (plain root shows a filesystem
`payload` with a `mountpoint`; LVM shows `logical_volumes`).

Not every image type accepts `partitioning_mode` / `filesystem` — check that
page’s supported blueprint options list.

Supported modes:
- `auto-lvm` uses raw unless [filesystem customizations](#filesystems) are included.
- `raw` always uses raw partitions
- `lvm` always uses LVM partitions
Supported modes (when the image type allows them):
- `auto-lvm` (default) — keep the image type’s base layout when you do not add new mountpoints; if the base is plain and the blueprint adds new mountpoints via [filesystems](#filesystems), convert to LVM
- `raw` — keep plain partitions (never convert to LVM or Btrfs; unsupported if the base is already LVM)
- `lvm` — always LVM
- `btrfs` — always Btrfs for root (extra mountpoints become subvolumes; see [Partitioning](./07-partitioning.md))

<Tabs values={tabValues} >
<TabItem value="on-premises" >
Expand Down Expand Up @@ -1727,8 +1736,9 @@ data = "<json-tailoring-file-contents>"
### FIPS 🔵 🟤 {#fips}

Enables/disables the system FIPS mode (disabled by default).
Currently only `edge-raw-image`, `edge-installer`, `edge-simplified-installer`,
`edge-ami` and `edge-vsphere` images support this customization.
Support depends on the image type — check the [image description](./09-image-descriptions/index.md)
`supported_options` list for `customizations.fips` (it is available on many
common disk image types, not only Edge).

<Tabs values={tabValues} >
<TabItem value="on-premises" >
Expand Down