diff options
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2024-02-09 12:01:11 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-02-09 12:01:11 +0000 |
commit | a7f4ae064427f40c35ca090b289405ca6df8533c (patch) | |
tree | a1450f244e91f7ac9b98977898d51c5725ede5c0 /nixos/doc | |
parent | b38903da74d4fa07bd7045e89bb31e6d4cc13548 (diff) | |
parent | cf57af7f537266c6e86f51cf1716aeb801a2d1cb (diff) | |
download | nixlib-a7f4ae064427f40c35ca090b289405ca6df8533c.tar nixlib-a7f4ae064427f40c35ca090b289405ca6df8533c.tar.gz nixlib-a7f4ae064427f40c35ca090b289405ca6df8533c.tar.bz2 nixlib-a7f4ae064427f40c35ca090b289405ca6df8533c.tar.lz nixlib-a7f4ae064427f40c35ca090b289405ca6df8533c.tar.xz nixlib-a7f4ae064427f40c35ca090b289405ca6df8533c.tar.zst nixlib-a7f4ae064427f40c35ca090b289405ca6df8533c.zip |
Merge master into staging-next
Diffstat (limited to 'nixos/doc')
-rw-r--r-- | nixos/doc/manual/configuration/file-systems.chapter.md | 1 | ||||
-rw-r--r-- | nixos/doc/manual/configuration/overlayfs.section.md | 27 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-2405.section.md | 5 |
3 files changed, 33 insertions, 0 deletions
diff --git a/nixos/doc/manual/configuration/file-systems.chapter.md b/nixos/doc/manual/configuration/file-systems.chapter.md index aca978be064d..3dfdd20ac33e 100644 --- a/nixos/doc/manual/configuration/file-systems.chapter.md +++ b/nixos/doc/manual/configuration/file-systems.chapter.md @@ -39,4 +39,5 @@ and non-critical by adding `options = [ "nofail" ];`. ```{=include=} sections luks-file-systems.section.md sshfs-file-systems.section.md +overlayfs.section.md ``` diff --git a/nixos/doc/manual/configuration/overlayfs.section.md b/nixos/doc/manual/configuration/overlayfs.section.md new file mode 100644 index 000000000000..592fb7c2e6f7 --- /dev/null +++ b/nixos/doc/manual/configuration/overlayfs.section.md @@ -0,0 +1,27 @@ +# Overlayfs {#sec-overlayfs} + +NixOS offers a convenient abstraction to create both read-only as well writable +overlays. + +```nix +fileSystems = { + "/writable-overlay" = { + overlay = { + lowerdir = [ writableOverlayLowerdir ]; + upperdir = "/.rw-writable-overlay/upper"; + workdir = "/.rw-writable-overlay/work"; + }; + # Mount the writable overlay in the initrd. + neededForBoot = true; + }; + "/readonly-overlay".overlay.lowerdir = [ + writableOverlayLowerdir + writableOverlayLowerdir2 + ]; +}; +``` + +If `upperdir` and `workdir` are not null, they will be created before the +overlay is mounted. + +To mount an overlay as read-only, you need to provide at least two `lowerdir`s. diff --git a/nixos/doc/manual/release-notes/rl-2405.section.md b/nixos/doc/manual/release-notes/rl-2405.section.md index c25fa3e07d33..ebb401cc42f0 100644 --- a/nixos/doc/manual/release-notes/rl-2405.section.md +++ b/nixos/doc/manual/release-notes/rl-2405.section.md @@ -278,6 +278,11 @@ The pre-existing [services.ankisyncd](#opt-services.ankisyncd.enable) has been m - The option [`services.nextcloud.config.dbport`] of the Nextcloud module was removed to match upstream. The port can be specified in [`services.nextcloud.config.dbhost`](#opt-services.nextcloud.config.dbhost). +- A new abstraction to create both read-only as well as writable overlay file + systems was added. Available via + [fileSystems.overlay](#opt-fileSystems._name_.overlay.lowerdir). See also the + [NixOS docs](#sec-overlayfs). + - `stdenv`: The `--replace` flag in `substitute`, `substituteInPlace`, `substituteAll`, `substituteAllStream`, and `substituteStream` is now deprecated if favor of the new `--replace-fail`, `--replace-warn` and `--replace-quiet`. The deprecated `--replace` equates to `--replace-warn`. - A new hardening flag, `zerocallusedregs` was made available, corresponding to the gcc/clang option `-fzero-call-used-regs=used-gpr`. |