Skip to content

Commit

Permalink
Add text about extensions
Browse files Browse the repository at this point in the history
Mimic opencontainers/image-spec#164
and they should be kept in-sync

Signed-off-by: Doug Davis <dug@us.ibm.com>
  • Loading branch information
Doug Davis committed Jul 7, 2016
1 parent b45aa77 commit aea2039
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,15 +308,23 @@ The semantics are the same as `Path`, `Args` and `Env` in [golang Cmd](https://g

This OPTIONAL property contains arbitrary metadata for the container.
This information MAY be structured or unstructured.
Annotations are key-value maps.
Annotations MUST be key-value maps where both the key and value are strings.
Keys MUST be unique, and best practice is to namespace the keys.
Keys starting with the `opencontainers.org` namespace are reserved and MUST NOT be used.
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.

```json
"annotations": {
"key1" : "value1",
"key2" : "value2"
"example.com/gpu-cores" : "2"
}
```

## Extensibility
The `annotations` property MAY be used as an extensibility point to include additional information that is not defined as part of this specification.
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unkown property.
Instead they MUST ignore unknown properties.

## Configuration Schema Example

Here is a full example `config.json` for reference.
Expand Down

0 comments on commit aea2039

Please sign in to comment.