Skip to content

Commit

Permalink
config: Split annotations restrictions into one-per-sentence
Browse files Browse the repository at this point in the history
As recommended by Daniel [1], although I've adjusted his recommended
wording slightly and split the requirements into paragraphs.

[1]: #654 (comment)

Signed-off-by: W. Trevor King <wking@tremily.us>
  • Loading branch information
wking committed Jan 13, 2017
1 parent 2c8feeb commit 9cc6137
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,15 +391,19 @@ If a hook returns a non-zero exit code, then an error is logged and the remainin

**`annotations`** (object, OPTIONAL) contains arbitrary metadata for the container.
This information MAY be structured or unstructured.
Annotations MUST be a key-value map where both the key and value MUST be strings.
While the value MUST be present, it MAY be an empty string.
Annotations MUST be a key-value map.
If there are no annotations then this property MAY either be absent or an empty map.

Keys MUST be strings.
Keys MUST be unique within this map.
Keys MUST NOT be an empty string.
Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`.
Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications.
If there are no annotations then this property MAY either be absent or an empty map.
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key.

Values MUST be strings.
Values MAY be an empty string.

```json
"annotations": {
"com.example.gpu-cores": "2"
Expand Down

0 comments on commit 9cc6137

Please sign in to comment.