Skip to content

Commit 3e6d666

Browse files
committed
Merge pull request #49 from jonboulle/master
config.md: various cleanup/consistency fixes
2 parents df70ac0 + bd2fd1a commit 3e6d666

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

config.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Below is a detailed description of each field defined in the configuration forma
1010

1111
## Manifest version
1212

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.
1414

1515
*Example*
1616

@@ -20,8 +20,10 @@ Below is a detailed description of each field defined in the configuration forma
2020

2121
## Root Configuration
2222

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.
2527

2628
*Example*
2729

@@ -34,11 +36,11 @@ Below is a detailed description of each field defined in the configuration forma
3436

3537
## Mount Configuration
3638

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)
3840

3941
* **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
4042
* **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.
4244
* **options** (string, optional) in the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
4345

4446
*Example (Linux)*
@@ -133,7 +135,7 @@ For Linux-based systems the user structure has the following fields:
133135
"hostname": "mrsdalloway"
134136
```
135137

136-
## Machine-specific configuration
138+
## Platform-specific configuration
137139

138140
* **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).
139141
* **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

Comments
 (0)