Skip to content

Commit

Permalink
filesystem: Doc etc.transient
Browse files Browse the repository at this point in the history
I noticed this was missing.

Signed-off-by: Colin Walters <[email protected]>
  • Loading branch information
cgwalters committed Dec 9, 2024
1 parent b90bf98 commit 22fc59b
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/src/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ in derived builds.
## `/etc`

The `/etc` directory contains mutable persistent state by default; however,
it is suppported to enable the [`etc.transient` config option](https://ostreedev.github.io/ostree/man/ostree-prepare-root.html).
it is suppported to enable the [`etc.transient` config option](https://ostreedev.github.io/ostree/man/ostree-prepare-root.html),
see below as well.

When in persistent mode, it inherits the OSTree semantics of [performing a 3-way merge](https://ostreedev.github.io/ostree/atomic-upgrades/#assembling-a-new-deployment-directory)
across upgrades. In a nutshell:
Expand Down Expand Up @@ -190,6 +191,24 @@ write (transiently, i.e. until the next reboot) to all top-level directories,
including `/usr` and `/opt`, with symlinks to `/var` for content that should
persist.

This can be combined with `etc.transient` as well (below).

## Enabling transient etc

The default (per above) is to have `/etc` persist. If however you do
not need to use it for any per-machine state, then enabling a transient
`/etc` is a great way to reduce the amount of possible state drift. Set
the

```toml
[etc]
transient = true
```

option in `prepare-root.conf`.

This can be combined with `root.transient` as well (above).

## Enabling state overlays

This feature enables a writable overlay on top of `/opt` (or really, any
Expand Down

0 comments on commit 22fc59b

Please sign in to comment.