Skip to content

Commit 173b7e2

Browse files
author
Mrunal Patel
committed
Merge pull request opencontainers#441 from wking/runtime-os-compatibility
config: Clarify MUST for platform.os and .arch
2 parents 5d27f3a + 35b0e9e commit 173b7e2

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

config.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,14 @@ _Note: For Solaris, uid and gid specify the uid and gid of the process inside th
190190

191191
## Platform
192192

193-
* **`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).
194-
* **`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).
193+
* **`os`** (string, required) specifies the operating system family this image targets.
194+
The runtime MUST generate an error if it does not support the configured **`os`**.
195+
Bundles SHOULD use, and runtimes SHOULD understand, **`os`** entries listed in the Go Language document for [`$GOOS`][go-environment].
196+
If an operating system is not included in the `$GOOS` documentation, it SHOULD be submitted to this specification for standardization.
197+
* **`arch`** (string, required) specifies the instruction set for which the binaries in the image have been compiled.
198+
The runtime MUST generate an error if it does not support the configured **`arch`**.
199+
Values for **`arch`** SHOULD use, and runtimes SHOULD understand, **`arch`** entries listed in the Go Language document for [`$GOARCH`][go-environment].
200+
If an architecture is not included in the `$GOARCH` documentation, it SHOULD be submitted to this specification for standardization.
195201

196202
### Example
197203

@@ -664,3 +670,4 @@ Here is a full example `config.json` for reference.
664670

665671
[runtime-namespace]: glossary.md#runtime-namespace
666672
[uts-namespace]: http://man7.org/linux/man-pages/man7/namespaces.7.html
673+
[go-environment]: https://golang.org/doc/install/source#environment

0 commit comments

Comments
 (0)