You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
config: Bump Hyper-V condition from root.path to root itself
Don't require users targetting Hyper-V to set an empty object ("root":
{}). This also avoids confusion about whether you can set
root.readonly without setting root.path (you can't).
Signed-off-by: W. Trevor King <[email protected]>
Copy file name to clipboardExpand all lines: config.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,18 +26,21 @@ For example, if a configuration is compliant with version 1.1 of this specificat
26
26
27
27
## <aname="configRoot" />Root
28
28
29
-
**`root`** (object, REQUIRED) specifies the container's root filesystem.
30
-
31
-
***`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.
32
-
Users SHOULD consider using a conventional name, such as `rootfs`.
33
-
34
-
On Windows, for Windows Server Containers, this field is REQUIRED. For Hyper-V Containers, this field MUST be omitted.
29
+
**`root`** (object, OPTIONAL) specifies the container's root filesystem.
30
+
On Windows, for Windows Server Containers, this field is REQUIRED.
31
+
For [Hyper-V Containers](config-windows.md#hyperv), this field MUST NOT be set.
35
32
36
33
On all other platforms, this field is REQUIRED.
37
34
35
+
***`path`** (string, REQUIRED) Specifies the path to the root filesystem for the container.
36
+
37
+
The path is either an absolute path or a relative path to the bundle.
38
38
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`.
39
39
40
-
If defined, a directory MUST exist at the path declared by the field.
40
+
Users SHOULD consider using a conventional name, such as `rootfs`.
41
+
42
+
A directory MUST exist at the path declared by the field.
43
+
41
44
***`readonly`** (bool, OPTIONAL) If true then the root filesystem MUST be read-only inside the container, defaults to false. On Windows, this field must be omitted or false.
0 commit comments