Skip to content
Open
Changes from all commits
Commits
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
31 changes: 15 additions & 16 deletions docs/src/experimental-composefs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
Experimental features are subject to change or removal. Please
do provide feedback on them.

Tracking issue: <https://github.com/bootc-dev/bootc/issues/1190>

## Overview

The composefs backend is an experimental alternative storage backend that uses [composefs-rs](https://github.com/containers/composefs-rs) instead of ostree for storing and managing bootc system deployments.
Expand Down Expand Up @@ -84,8 +82,6 @@ EORUN
# Final image: copy the sealed UKI into place
FROM rootfs
COPY --from=sealed-uki /out/*.efi /boot/EFI/Linux/
# Remove raw kernel/initramfs (now embedded in UKI)
RUN rm -f /usr/lib/modules/*/vmlinuz /usr/lib/modules/*/initramfs.img
```

This pattern works because:
Expand Down Expand Up @@ -140,21 +136,24 @@ To use sealed images, the container image must have a UKI and systemd-boot insta

There is a `--composefs-backend` option for `bootc install` to explicitly select a composefs backend apart from sealed images; this is not as heavily tested yet.

## Current Limitations
## Known Issues

The composefs backend is experimental; on-disk formats are subject to change.

### Deployment blockers

- [Garbage collection](https://github.com/containers/composefs-rs/pull/200): Old deployments are not cleaned up
- [SELinux enforcement](https://github.com/bootc-dev/bootc/issues/1826): Currently requires `enforcing=0`
- [OCI registry install](https://github.com/bootc-dev/bootc/issues/1703): Installing from registry can fail due to config mismatch

### Important

- **Experimental**: The on-disk formats are subject to change
- **UX refinement**: The user experience for building and managing sealed images is still being improved
- **SELinux**: Currently uses `enforcing=0` in the kernel command line (see [#1826](https://github.com/bootc-dev/bootc/issues/1826))
- **kargs.d**: Custom kernel arguments from `/usr/lib/bootc/kargs.d` are not yet automatically included in sealed UKIs
- [Sealed image build UX](https://github.com/bootc-dev/bootc/issues/1498): Streamlined tooling for building sealed images
- **kargs.d**: Custom kernel arguments from `/usr/lib/bootc/kargs.d` not yet included in sealed UKIs
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The use of bold formatting for the kargs.d item is inconsistent with the other items in this list, which are either links or plain text. For better visual consistency, I suggest removing the bolding.

Suggested change
- **kargs.d**: Custom kernel arguments from `/usr/lib/bootc/kargs.d` not yet included in sealed UKIs
- kargs.d: Custom kernel arguments from `/usr/lib/bootc/kargs.d` not yet included in sealed UKIs

Copy link
Contributor

Choose a reason for hiding this comment

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

This can only happen with UKI addons as we can not modify the kargs of signed UKIs

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Right, but this is about automatically inserting those kargs when generating a UKI at build time.


## Related Issues
### Long-term

- [#1190](https://github.com/bootc-dev/bootc/issues/1190) - composefs-native backend (main tracker)
- [#1498](https://github.com/bootc-dev/bootc/issues/1498) - Sealed image build UX + implementation
- [#1703](https://github.com/bootc-dev/bootc/issues/1703) - OCI config mismatch issues
- [#1826](https://github.com/bootc-dev/bootc/issues/1826) - SELinux enforcement with composefs
- [#20](https://github.com/bootc-dev/bootc/issues/20) - Unified storage (long-term goal)
- [#806](https://github.com/bootc-dev/bootc/issues/806) - UKI/systemd-boot tracker
- [Unified storage](https://github.com/bootc-dev/bootc/issues/20)
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

It appears the tracker for UKI/systemd-boot improvements (#806) was omitted from the new 'Known Issues' section. The PR description mentions this as a long-term goal, and it was present in the old 'Related Issues' list. It would be good to include it here for completeness.

Suggested change
- [Unified storage](https://github.com/bootc-dev/bootc/issues/20)
- [Unified storage](https://github.com/bootc-dev/bootc/issues/20)
- [UKI/systemd-boot improvements](https://github.com/bootc-dev/bootc/issues/806)


## Additional Resources

Expand Down