Skip to content

config: Bring "unique... within this map" back together #654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrunalp merged 2 commits into from
Jan 18, 2017
Merged

config: Bring "unique... within this map" back together #654

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c8feeb
config: Bring "unique... within this map" back together
wking Jan 12, 2017
9cc6137
config: Split annotations restrictions into one-per-sentence
wking Jan 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,14 +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.
Keys MUST be unique and MUST NOT be an empty string within this map, and best practice is to namespace the keys.
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`.
Copy link
Contributor

@dqminh dqminh Jan 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

while we are here, its also clearer to me when we restructure the above paragraph to follow one a keyword per line.
For example

Annotations MUST be a key-value map
Keys MUST be string.
Keys MUST be unique within this map.
Keys MUST NOT be empty.
Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications.
Values MUST be string.
Values MUST be present.
Values MAY be empty.

wdyt ?

Copy link
Contributor Author

@wking wking Jan 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done (with paragraphs and slightly different wording) in 2c8feeb → 9cc6137.

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