Skip to content

Commit 1f2a4e3

Browse files
author
Doug Davis
committed
Add text about extensions
Mimic opencontainers/image-spec#164 and they should be kept in-sync Signed-off-by: Doug Davis <[email protected]>
1 parent b45aa77 commit 1f2a4e3

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

config.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,10 @@ The semantics are the same as `Path`, `Args` and `Env` in [golang Cmd](https://g
308308

309309
This OPTIONAL property contains arbitrary metadata for the container.
310310
This information MAY be structured or unstructured.
311-
Annotations are key-value maps.
311+
Annotations MUST be key-value maps.
312+
Keys MUST be unique, and best practice is to namespace the keys.
313+
If there are no annotations then this property MAY either be absent or an empty map.
314+
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key.
312315

313316
```json
314317
"annotations": {
@@ -317,6 +320,10 @@ Annotations are key-value maps.
317320
}
318321
```
319322

323+
## Extensibility
324+
The `annotations` property MAY be used as an extensibility point to include additional information that is not defined as part of this specification.
325+
Excluding the `annotations` property, implementations that are reading/processing this configuration file MUST generate an error if they encounter an unkown property.
326+
320327
## Configuration Schema Example
321328

322329
Here is a full example `config.json` for reference.

0 commit comments

Comments
 (0)