jasder
/
runc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add text about extensions 

Mimic https://github.com/opencontainers/image-spec/pull/164
and they should be kept in-sync

Signed-off-by: Doug Davis <dug@us.ibm.com>
This commit is contained in:
Doug Davis 2016-06-26 12:49:13 -07:00
parent d3c3763b9f
commit 27a05de3f6
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
config.md
View File

@ -324,15 +324,24 @@ The semantics are the same as `Path`, `Args` and `Env` in [golang Cmd](https://g
**`annotations`** (object, optional) contains arbitrary metadata for the container. **`annotations`** (object, optional) contains arbitrary metadata for the container.
This information MAY be structured or unstructured. This information MAY be structured or unstructured.
Annotations are key-value maps. 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 within this map, and best practice is to namespace the keys.
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.
```json ```json
"annotations": { "annotations": {
"key1" : "value1", "com.example.gpu-cores" : "2"
"key2" : "value2"
} }
``` ```
## Extensibility
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 ## Configuration Schema Example
Here is a full example `config.json` for reference. Here is a full example `config.json` for reference.
@ -683,8 +692,8 @@ Here is a full example `config.json` for reference.
"mountLabel": "system_u:object_r:svirt_sandbox_file_t:s0:c715,c811" "mountLabel": "system_u:object_r:svirt_sandbox_file_t:s0:c715,c811"
}, },
"annotations": { "annotations": {
"key1": "value1", "com.example.key1": "value1",
"key2": "value2" "com.example.key2": "value2"
} }
} }
``` ```