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
Copy file name to clipboardExpand all lines: config.md
+8-6
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Below is a detailed description of each field defined in the configuration forma
10
10
11
11
## Manifest version
12
12
13
-
***version** (string, required) must be in SemVer v2.0.0 format and specifies the version of the OCF specification which the container bundle complies. The Open Container spec follows semantic versioning and retain forward and backwards compatibility within major versions. For example, if an implementation is compliant against version 1.0.1 of the spec, it is compatible with the complete 1.x series.
13
+
***version** (string, required) must be in SemVer v2.0.0 format and specifies the version of the OCF specification with which the container bundle complies. The Open Container spec follows semantic versioning and retains forward and backward compatibility within major versions. For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series.
14
14
15
15
*Example*
16
16
@@ -20,8 +20,10 @@ Below is a detailed description of each field defined in the configuration forma
20
20
21
21
## Root Configuration
22
22
23
-
***path** (string, required) Each container has exactly one *root filesystem*. The path string element specifies the path to the root file system for the container, relative to the path where the manifest is. A directory MUST exist at the relative path declared by the field.
24
-
***readonly** (bool, optional) If true then the root file system MUST be read-only inside the container. Defaults to false.
23
+
Each container has exactly one *root filesystem*, specified in the *root* object:
24
+
25
+
***path** (string, required) Specifies the path to the root filesystem for the container, relative to the path where the manifest is. A directory MUST exist at the relative path declared by the field.
26
+
***readonly** (bool, optional) If true then the root filesystem MUST be read-only inside the container. Defaults to false.
25
27
26
28
*Example*
27
29
@@ -34,11 +36,11 @@ Below is a detailed description of each field defined in the configuration forma
34
36
35
37
## Mount Configuration
36
38
37
-
Additional file systems can be declared as "mounts", declared by the array element mounts. The parameters are similar to the ones in Linux mount system call. [http://linux.die.net/man/2/mount](http://linux.die.net/man/2/mount)
39
+
Additional filesystems can be declared as "mounts", specified in the *mounts* array. The parameters are similar to the ones in Linux mount system call. [http://linux.die.net/man/2/mount](http://linux.die.net/man/2/mount)
38
40
39
41
***type** (string, required) Linux, *filesystemtype* argument supported by the kernel are listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660"). Windows: ntfs
40
42
***source** (string, required) a device name, but can also be a directory name or a dummy. Windows, the volume name that is the target of the mount point. \\?\Volume\{GUID}\ (on Windows source is called target)
41
-
***destination** (string, required) where the source file system is mounted relative to the container rootfs.
43
+
***destination** (string, required) where the source filesystem is mounted relative to the container rootfs.
42
44
***options** (string, optional) in the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
43
45
44
46
*Example (Linux)*
@@ -133,7 +135,7 @@ For Linux-based systems the user structure has the following fields:
133
135
"hostname": "mrsdalloway"
134
136
```
135
137
136
-
## Machine-specific configuration
138
+
## Platform-specific configuration
137
139
138
140
***os** (string, required) specifies the operating system family this image must run on. Values for arch must be in the list specified by the Go Language document for [$GOOS](https://golang.org/doc/install/source#environment).
139
141
***arch** (string, required) specifies the instruction set for which the binaries in the image have been compiled. Values for arch must be in the list specified by the Go Language document for [$GOARCH](https://golang.org/doc/install/source#environment).
0 commit comments