Skip to content

Docs growfs - #2610

Open
jmarrero wants to merge 2 commits into
bootc-dev:mainfrom
jmarrero:docs-growfs
Open

jmarrero wants to merge 2 commits into
bootc-dev:mainfrom
jmarrero:docs-growfs

Conversation

@jmarrero

@jmarrero jmarrero commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

#2465 showed it isn't obvious who grows the root filesystem when a bootc disk image boots on a bigger disk: bootc doesn't, and whether it happens depends on what the base image ships. I'd like the docs to say that plainly for base image authors and point at what exists today, so anyone building a custom or minimal image knows they need to bring their own.

The text predates composefs and still says / is a bind mount of the
deployment directory. With composefs enabled, which the docs
recommend and the composefs backend always uses, / is a composefs
mount instead, and its mount source is no longer the root block
device. That matters for tools that look at / to find the disk.

Assisted-by: AI
Signed-off-by: Joseph Marrero Corchado <jmarrero@redhat.com>
Copilot AI balanced review requested due to automatic review settings October 31, 2026 18:56
@github-actions github-actions Bot added the area/documentation Updates to the documentation label Oct 31, 2026
@bootc-bot
bootc-bot Bot requested a review from henrywang October 31, 2026 18:56

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The upgrade description incorrectly states that composefs image files are stored in an OSTree repository rather than /sysroot/composefs, so the storage location needs to be qualified by backend.

1 open issue
What changed in this PR

Clarifies that growing a root filesystem on a larger disk is the image’s responsibility, not bootc’s, helping custom and minimal image authors choose suitable tooling.

Changes:

  • Documents existing growth services and cloud-init limitations with composefs.
  • Clarifies logical-root mounts and corrects the systemd-growfs command name.
  • Links installation and image-authoring guidance to the expansion documentation.
File Description
docs/​src/​bootc-sysroot.7.md Expands filesystem-growth guidance and clarifies composefs mounts.
docs/​src/​bootc-installation.7.md Links provisioning guidance to filesystem expansion.
docs/​src/​bootc-compatible-images.7.md Explains image authors’ responsibility for filesystem growth.

Review effort: Balanced

Comment thread docs/src/bootc-sysroot.7.md Resolved
Base image authors need to know that disk images booted on larger
disks, as in the cloud, need their root grown, and that bootc leaves
this to the image. Provisioning tools are often assumed to take care
of it, but the image based systems that do it (the Fedora and CentOS
Stream bootc base images, Fedora CoreOS, Flatcar) each use a separate
service, and cloud-init's growpart and resizefs can't find the device
when / is a composefs mount.

Point to those services and their docs from bootc-sysroot(7), note
that minimal image variants may need one layered in, and link there
from the image requirements and provisioning sections. Also fix the
systemd-growfs typo.

Assisted-by: AI
Signed-off-by: Joseph Marrero Corchado <jmarrero@redhat.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Updates to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants