diff --git a/config.md b/config.md index 8b6bdd314..8925318e1 100644 --- a/config.md +++ b/config.md @@ -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`. 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"