Skip to content

Commit

Permalink
Add a page for composefs
Browse files Browse the repository at this point in the history
We added composeFS starting in f41. Since it comes with a couple of
drawbacks let's document it and explain how to disable it.

coreos/fedora-coreos-tracker#1718 (comment)
coreos/fedora-coreos-config#3009
  • Loading branch information
jbtrystram committed Sep 6, 2024
1 parent 8bb4e0e commit b653134
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
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

Right now, this prevents kdump from generating it's initramfs as it get confused by the read-only filesystem.
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].

=== 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
----

.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.

== Links

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

0 comments on commit b653134

Please sign in to comment.