diff --git a/config.md b/config.md index 98f1a384d..9816b711e 100644 --- a/config.md +++ b/config.md @@ -28,10 +28,11 @@ For example, if a configuration is compliant with version 1.1 of this specificat **`root`** (object, REQUIRED) specifies the container's root filesystem. -* **`path`** (string, REQUIRED) Specifies the path to the root filesystem for the container. +* **`path`** (string, OPTIONAL) Specifies the path to the root filesystem for the container. The path is either an absolute path or a relative path to the bundle. - On Linux, for example, with a bundle at `/to/bundle` and a root filesystem at `/to/bundle/rootfs`, the `path` value can be either `/to/bundle/rootfs` or `rootfs`. - A directory MUST exist at the path declared by the field. + On Linux, for example, with a bundle at `/to/bundle` and a root filesystem at `/to/bundle/rootfs`, the `path` value can be either `/to/bundle/rootfs` or `rootfs`. On Linux, this field is REQUIRED. + On Windows, for Windows Server Containers, this field is REQUIRED. For Hyper-V Containers, this field MUST NOT be supplied. + If defined, a directory MUST exist at the path declared by the field. * **`readonly`** (bool, OPTIONAL) If true then the root filesystem MUST be read-only inside the container, defaults to false. ### Example