docs/composefs: Add note about toplevel dirs
authorColin Walters <walters@verbum.org>
Tue, 2 Jan 2024 20:16:47 +0000 (15:16 -0500)
committerColin Walters <walters@verbum.org>
Tue, 2 Jan 2024 20:18:37 +0000 (15:18 -0500)
Just thinking about trying to land this, I think some people
may hit this one.

docs/composefs.md

index ebc26af3cbb6bc21c7fdc8ce99bdf48413ef61b9..b95c61f6b429aee329bef4040b9f50a7520b9063 100644 (file)
@@ -87,6 +87,19 @@ At the current time, there are no additional userspace runtime requirements.
 **IMPORTANT** The integration with composefs is experimental and subject to change.  Please
 try it and report issues but do not deploy to production systems yet.
 
+## Compatiblity
+
+One issue that ostree users transitioning to composefs may hit is that it is no
+longer possible to add new toplevel directories via the `chattr -i / && mkdir /somedir && chattr -i`
+trick.   A bit more on this in the following issues:
+
+* <https://github.com/coreos/rpm-ostree/issues/337>
+* <https://github.com/ostreedev/ostree/pull/2681>
+
+However, users who were doing things like this probably want to enable the
+`root.transient` option; see `man ostree-prepare-root` which will allow
+this (but also change other behaviors too).
+
 ## Comparison with other approaches
 
 There is also support for using [IMA](ima.md) with ostree.  In short, composefs