about summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorIngo Blechschmidt <iblech@speicherleck.de>2020-04-22 05:30:48 +0200
committerGitHub <noreply@github.com>2020-04-22 05:30:48 +0200
commit2e2da182fefe41b0b1c962995450a83243fafb32 (patch)
treef91c998b2713adea0d7c8f0f80b2c6b5bb09d554 /nixos
parent512a85d334ea20186a1f150df3b4447bd0c3e7fa (diff)
downloadnixlib-2e2da182fefe41b0b1c962995450a83243fafb32.tar
nixlib-2e2da182fefe41b0b1c962995450a83243fafb32.tar.gz
nixlib-2e2da182fefe41b0b1c962995450a83243fafb32.tar.bz2
nixlib-2e2da182fefe41b0b1c962995450a83243fafb32.tar.lz
nixlib-2e2da182fefe41b0b1c962995450a83243fafb32.tar.xz
nixlib-2e2da182fefe41b0b1c962995450a83243fafb32.tar.zst
nixlib-2e2da182fefe41b0b1c962995450a83243fafb32.zip
nixos-containers: add docs about nested containers
Diffstat (limited to 'nixos')
-rw-r--r--nixos/modules/virtualisation/nixos-containers.nix12
1 files changed, 9 insertions, 3 deletions
diff --git a/nixos/modules/virtualisation/nixos-containers.nix b/nixos/modules/virtualisation/nixos-containers.nix
index 2db5c117aa7f..4f5be91939db 100644
--- a/nixos/modules/virtualisation/nixos-containers.nix
+++ b/nixos/modules/virtualisation/nixos-containers.nix
@@ -440,7 +440,9 @@ in
       default = false;
       description = ''
         Whether this NixOS machine is a lightweight container running
-        in another NixOS system.
+        in another NixOS system. If set to true, support for nested
+        containers is disabled by default, but can be reenabled by
+        setting <config>boot.enableContainers</config> to true.
       '';
     };
 
@@ -448,7 +450,11 @@ in
       type = types.bool;
       default = !config.boot.isContainer;
       description = ''
-        Whether to enable support for NixOS containers.
+        Whether to enable support for NixOS containers. Defaults to true
+        (at no cost if containers are not actually used), but only if the
+        system is not itself a lightweight container of a host.
+        To enable support for nested containers, this option has to be
+        explicitly set to true (in the outer container).
       '';
     };
 
@@ -596,7 +602,7 @@ in
               type = with types; attrsOf (submodule { options = networkOptions; });
               default = {};
               description = ''
-                Extra veth-pairs to be created for the container
+                Extra veth-pairs to be created for the container.
               '';
             };