Skip to content

Commit

Permalink
Merge pull request #441 from wking/runtime-os-compatibility
Browse files Browse the repository at this point in the history
config: Clarify MUST for platform.os and .arch
  • Loading branch information
Mrunal Patel committed May 20, 2016
2 parents 5d27f3a + 35b0e9e commit 173b7e2
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,14 @@ _Note: For Solaris, uid and gid specify the uid and gid of the process inside th

## Platform

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

### Example

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

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

0 comments on commit 173b7e2

Please sign in to comment.