doc/images: introduce requirements.nesting

Signed-off-by: Adam Stephens <adam@valkor.net>
lxc · Mar 23, 2024 · a9d2cf8 · a9d2cf8
1 parent f5d48d2
commit a9d2cf8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/doc/api-extensions.md b/doc/api-extensions.md
@@ -2400,3 +2400,7 @@ This adds `balanced` as a new value for `limits.cpu.nodes`.
 When set to `balanced`, Incus will attempt to select the least busy NUMA
 node at startup time for the instance, trying to keep the load spread
 across NUMA nodes on the system.
+
+## `image_restriction_nesting`
+
+This extension adds a new image restriction, `requirements.nesting` which when `true` indicates that an image cannot be run without nesting.
diff --git a/doc/image-handling.md b/doc/image-handling.md
@@ -58,5 +58,6 @@ Key                                         | Type      | Default      | Descrip
 :--                                         | :---      | :------      | :----------
 `requirements.cdrom_agent`                  | bool      | -            | If set to `true`, indicates that the VM requires an `agent:config` disk be added.
 `requirements.cgroup`                       | string    | -            | If set to `v1`, indicates that the image requires the host to run cgroup v1.
+`requirements.nesting`                      | bool      | -            | If set to `true`, indicates that the image cannot work without nesting enabled.
 `requirements.privileged`                   | bool      | -            | If set to `false`, indicates that the image cannot work as a privileged container.
 `requirements.secureboot`                   | bool      | -            | If set to `false`, indicates that the image cannot boot under secure boot.