-
Notifications
You must be signed in to change notification settings - Fork 154
docs: Add experimental-composefs #1706
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
Merged
+86
−0
Merged
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,85 @@ | ||
| # composefs backend | ||
|
|
||
| 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. | ||
|
|
||
| **Status**: Experimental. The composefs backend is under active development and not yet suitable for production use. The feature is currently gated behind the `composefs-backend` compile-time feature flag, which in current git main is enabled by default. | ||
|
|
||
| ## Key Benefits | ||
|
|
||
| - **Native container integration**: Direct use of container image formats without the ostree layer | ||
| - **UKI support**: First-class support for Unified Kernel Images (UKIs) and systemd-boot | ||
| - **Sealed images**: Enables building cryptographically sealed, securely-bootable images | ||
| - **Simpler architecture**: Reduces dependency on ostree as an implementation detail | ||
|
|
||
| ## Building Sealed Images | ||
|
|
||
| ### Using `just build-sealed` | ||
|
|
||
| This is an entrypoint focused on *bootc development* itself - it builds bootc | ||
| from source. | ||
|
|
||
| ```bash | ||
| just build-sealed | ||
| ``` | ||
|
|
||
| We are working on documenting individual steps to build a sealed image outside of | ||
| this tooling. | ||
|
|
||
| ## How Sealed Images Work | ||
|
|
||
| A sealed image includes: | ||
| - A Unified Kernel Image (UKI) that combines kernel, initramfs, and boot parameters | ||
| - The composefs fsverity digest embedded in the kernel command line | ||
| - Secure Boot signatures on both the UKI and systemd-boot loader | ||
|
|
||
| The UKI is placed in `/boot/EFI/Linux/` and includes the composefs digest in its command line: | ||
| ``` | ||
| composefs=${COMPOSEFS_FSVERITY} root=UUID=... | ||
cgwalters marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| This enables the boot chain to verify the integrity of the root filesystem. | ||
|
|
||
| ## Installation | ||
|
|
||
| When installing a composefs-backend system, use: | ||
|
|
||
| ```bash | ||
| bootc install to-disk /dev/sdX | ||
| ``` | ||
|
|
||
| **Note**: Sealed images will require fsverity support on the target filesystem by default. | ||
|
|
||
| ## Testing Composefs | ||
|
|
||
| To run the composefs integration tests: | ||
|
|
||
| ```bash | ||
| just test-composefs | ||
| ``` | ||
|
|
||
| This builds a sealed image and runs the composefs test suite using `bcvk` (bootc VM tooling). | ||
|
|
||
| ## Current Limitations | ||
|
|
||
| - **Experimental**: In particular, the on-disk formats are subject to change | ||
| - **UX refinement**: The user experience for building and managing sealed images is still being improved | ||
|
|
||
| ## Related Issues | ||
|
|
||
| - [#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 | ||
| - [#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 | ||
|
|
||
| ## Additional Resources | ||
|
|
||
| - See [filesystem.md](filesystem.md) for information about composefs in the standard ostree backend | ||
| - See [bootloaders.md](bootloaders.md) for bootloader configuration details | ||
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.