Skip to content
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

Add a page for composefs #663

Merged
merged 1 commit into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
** xref:time-zone.adoc[Configuring Time Zone]
** xref:grub-password.adoc[Setting a GRUB password]
** xref:audit.adoc[Managing the audit daemon]
** xref:composefs.adoc[ComposeFS]
* OS updates
** xref:update-streams.adoc[Update Streams]
** xref:auto-updates.adoc[Auto-Updates]
Expand Down
53 changes: 53 additions & 0 deletions modules/ROOT/pages/composefs.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
= Composefs

Fedora CoreOS introduced composefs enabled by default starting in Fedora 41. Composefs is an overlay filesystem where the data comes from the usual ostree deployement, and
metadata are in the composefs file. The result is a truely read-only root (`/`) filesystem, increasing the system integrity and robustness,

This is a first step towards a full verification of filesystem integrity, even at runtime.

== What does it change ?

The main visible change will be that the root filesystem (/) is now small and full (a few MB, 100% used).

== Known issues

=== Kdump
Copy link
Member

Choose a reason for hiding this comment

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

i'm really hoping we can have kdump fixed before F41 gets promoted to our stable stream.


Right now, this prevents kdump from generating it's initramfs as it get confused by the read-only filesystem.
jbtrystram marked this conversation as resolved.
Show resolved Hide resolved
If you want to use kdump and export kernels dumps to the local machine, composefs must be disabled.
A workaround is to configure kdump with a remote target such as ssh or nfs.
The kdump upstream developers are working on a fix. We will update this page when the workaround is no longer needed.

See [https://github.com/rhkdump/kdump-utils/pull/28 rhkdump/kdump-utils#28].
jbtrystram marked this conversation as resolved.
Show resolved Hide resolved

=== Top-level directories

Another consequence is that it is now impossible to create top-level directories in `/`.
A common use case for those top level directories is to use them as mount points.
We recommend using sub directories in `/var` instead.
Currently, the only way around that is to disable composefs as shown below.

== Disable composefs

Composefs can be disabled through a kernel argument: `ostree.prepare-root.composefs=0`.

.Disabling composefs at provisionning
[source,yaml,subs="attributes"]
----
variant: fcos
version: {butane-latest-stable-spec}
kernel_arguments:
should_exist:
- ostree.prepare-root.composefs=0
----

jbtrystram marked this conversation as resolved.
Show resolved Hide resolved
.Disabling composefs on a running FCOS system
[source,bash]
----
$ sudo rpm-ostree kargs --append='ostree.prepare-root.composefs=0'
----
Note that a reboot is required for the change to take effect.

jbtrystram marked this conversation as resolved.
Show resolved Hide resolved
== Links

https://fedoraproject.org/wiki/Changes/ComposefsAtomicCoreOSIoT
Loading