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
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The OpenContainer spec follows semantic versioning and retains forward and backw
15
15
For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series.
16
16
NOTE that there is no guarantee for forward or backward compatibility for version 0.x.
17
17
18
-
*Example*
18
+
### Example
19
19
20
20
```json
21
21
"ociVersion": "0.1.0"
@@ -28,7 +28,7 @@ Each container has exactly one *root filesystem*, specified in the *root* object
28
28
***`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.
29
29
***`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container. Defaults to false.
30
30
31
-
*Example*
31
+
### Example
32
32
33
33
```json
34
34
"root": {
@@ -48,7 +48,7 @@ The parameters are similar to the ones in [the Linux mount system call](http://m
48
48
***`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)
49
49
***`options`** (list of strings, optional) in the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
50
50
51
-
### Linux Example
51
+
### Example (Linux)
52
52
53
53
```json
54
54
"mounts": [
@@ -67,7 +67,7 @@ The parameters are similar to the ones in [the Linux mount system call](http://m
67
67
]
68
68
```
69
69
70
-
### Windows Example
70
+
### Example (Windows)
71
71
72
72
```json
73
73
"mounts": [
@@ -111,7 +111,7 @@ For Linux-based systems the user structure has the following fields:
111
111
***`gid`** (int, required) specifies the group id.
112
112
***`additionalGids`** (array of ints, optional) specifies additional group ids to be added to the process.
113
113
114
-
*Example (Linux)*
114
+
### Example (Linux)
115
115
116
116
```json
117
117
"process": {
@@ -152,7 +152,7 @@ For Linux-based systems the user structure has the following fields:
152
152
153
153
***`hostname`** (string, optional) as it is accessible to processes running inside. On Linux, you can only set this if your bundle creates a new [UTS namespace][uts-namespace].
154
154
155
-
*Example*
155
+
### Example
156
156
157
157
```json
158
158
"hostname": "mrsdalloway"
@@ -163,6 +163,8 @@ For Linux-based systems the user structure has the following fields:
163
163
***`os`** (string, required) specifies the operating system family this image must run on. Values for os must be in the list specified by the Go Language document for [`$GOOS`](https://golang.org/doc/install/source#environment).
164
164
***`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).
165
165
166
+
### Example
167
+
166
168
```json
167
169
"platform": {
168
170
"os": "linux",
@@ -209,7 +211,7 @@ The post-stop hooks are called after the container process is stopped.
209
211
Cleanup or debugging could be performed in such a hook.
210
212
If a hook returns a non-zero exit code, then an error is logged and the remaining hooks are executed.
0 commit comments