Skip to content

Commit 23a0b15

Browse files
author
John Howard
committed
Clarify root path
Signed-off-by: John Howard <[email protected]>
1 parent ce6011c commit 23a0b15

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

config.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@ For example, if a configuration is compliant with version 1.1 of this specificat
2828

2929
**`root`** (object, REQUIRED) specifies the container's root filesystem.
3030

31-
* **`path`** (string, REQUIRED) Specifies the path to the root filesystem for the container.
31+
* **`path`** (string, OPTIONAL) Specifies the path to the root filesystem for the container.
3232
The path is either an absolute path or a relative path to the bundle.
33-
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`.
34-
A directory MUST exist at the path declared by the field.
33+
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`.
34+
On Windows, for Windows Server Containers, this field is REQUIRED. For Hyper-V Containers, this field MUST NOT be supplied.
35+
On all other platforms, this field is REQUIRED.
36+
If defined, a directory MUST exist at the path declared by the field.
3537
* **`readonly`** (bool, OPTIONAL) If true then the root filesystem MUST be read-only inside the container, defaults to false.
3638

3739
### Example

0 commit comments

Comments
 (0)