manifest: add annotations

vbatts · vbatts · commit 78c7ff7fde7d · 2016-04-29T14:13:44.000-04:00
This introduces OPTIONAL annotations, which are consistent with the
annotations in the runtime-spec.

While the spec does not exclude use of arbitrary fields, this OPTIONAL
property gives a guided place for manifest authors to isolate their
arbitrary metadata.

Signed-off-by: Vincent Batts &lt;vbatts@hashbangbash.com&gt;
diff --git a/manifest.md b/manifest.md
@@ -81,6 +81,18 @@ A client will distinguish a manifest list from an image manifest based on the Co
 
         This OPTIONAL property specifies an array of strings, each specifying a mandatory CPU feature (for example `sse4` or `aes`).
 
+- **`annotations`** *string-string hashmap*
+
+    This OPTIONAL property contains arbitrary metadata for the manifest list.
+    Annotations is a key-value, unordered hashmap.
+    Keys are unique, and best practice is to namespace the keys.
+    Common annotation keys include:
+    * **created** date on which the image was built (string, timestamps type)
+    * **authors** contact details of the people or organization responsible for the image (freeform string)
+    * **homepage** URL to find more information on the image (string, must be a URL with scheme HTTP or HTTPS)
+    * **documentation** URL to get documentation on the image (string, must be a URL with scheme HTTP or HTTPS)
+
+
 ## Example Manifest List
 
 *Example showing a simple manifest list pointing to image manifests for two platforms:*
@@ -110,7 +122,11 @@ A client will distinguish a manifest list from an image manifest based on the Co
         ]
       }
     }
-  ]
+  ],
+  "annotations": {
+    "key1": "value1",
+    "key2": "value2",
+  }
 }
 ```
 
@@ -174,6 +190,18 @@ The image manifest provides a configuration and a set of layers for a container
 
         The digest of the content, as defined by the [Registry V2 HTTP API Specificiation](https://docs.docker.com/registry/spec/api/#digest-parameter).
 
+- **`annotations`** *hashmap*
+
+    This OPTIONAL property contains arbitrary metadata for the manifest list.
+    Annotations is a key-value, unordered hashmap.
+    Keys are unique, and best practice is to namespace the keys.
+    Common annotation keys include:
+    * **created** date on which the image was built (string, timestamps type)
+    * **authors** contact details of the people or organization responsible for the image (freeform string)
+    * **homepage** URL to find more information on the image (string, must be a URL with scheme HTTP or HTTPS)
+    * **documentation** URL to get documentation on the image (string, must be a URL with scheme HTTP or HTTPS)
+
+
 ## Example Image Manifest
 
 *Example showing an image manifest:*
@@ -202,7 +230,11 @@ The image manifest provides a configuration and a set of layers for a container
       "size": 73109,
       "digest": "sha256:ec4b8955958665577945c89419d1af06b5f7636b4ac3da7f12184802ad867736"
     }
-  ]
+  ],
+  "annotations": {
+    "key1": "value1",
+    "key2": "value2",
+  }
 }
 ```
 
diff --git a/schema/defs-image.json b/schema/defs-image.json
@@ -94,6 +94,17 @@
           }
         }
       }
+    },
+    "annotations": {
+      "id": "https://opencontainers.org/schema/image/annotations",
+      "oneOf": [
+        {
+          "$ref": "defs.json#/definitions/mapStringString"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   }
 }
diff --git a/schema/image-manifest-schema.json b/schema/image-manifest-schema.json
@@ -21,6 +21,10 @@
       "items": {
         "$ref": "defs-image.json#/definitions/descriptor"
       }
+    },
+    "annotations": {
+      "id": "https://opencontainers.org/schema/image/manifest-list/annotations",
+      "$ref": "defs-image.json#/definitions/annotations"
     }
   },
   "required": [
diff --git a/schema/manifest-list-schema.json b/schema/manifest-list-schema.json
@@ -18,6 +18,10 @@
       "items": {
         "$ref": "defs-image.json#/definitions/manifestDescriptor"
       }
+    },
+    "annotations": {
+      "id": "https://opencontainers.org/schema/image/manifest-list/annotations",
+      "$ref": "defs-image.json#/definitions/annotations"
     }
   },
   "required": [

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,17 @@`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`	`}`
	`97`	`+ },`
	`98`	`+ "annotations": {`
	`99`	`+ "id": "https://opencontainers.org/schema/image/annotations",`
	`100`	`+ "oneOf": [`
	`101`	`+ {`
	`102`	`+ "$ref": "defs.json#/definitions/mapStringString"`
	`103`	`+ },`
	`104`	`+ {`
	`105`	`+ "type": "null"`
	`106`	`+ }`
	`107`	`+ ]`
`97`	`108`	`}`
`98`	`109`	`}`
`99`	`110`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,10 @@`
`21`	`21`	`"items": {`
`22`	`22`	`"$ref": "defs-image.json#/definitions/descriptor"`
`23`	`23`	`}`
	`24`	`+ },`
	`25`	`+ "annotations": {`
	`26`	`+ "id": "https://opencontainers.org/schema/image/manifest-list/annotations",`
	`27`	`+ "$ref": "defs-image.json#/definitions/annotations"`
`24`	`28`	`}`
`25`	`29`	`},`
`26`	`30`	`"required": [`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,10 @@`
`18`	`18`	`"items": {`
`19`	`19`	`"$ref": "defs-image.json#/definitions/manifestDescriptor"`
`20`	`20`	`}`
	`21`	`+ },`
	`22`	`+ "annotations": {`
	`23`	`+ "id": "https://opencontainers.org/schema/image/manifest-list/annotations",`
	`24`	`+ "$ref": "defs-image.json#/definitions/annotations"`
`21`	`25`	`}`
`22`	`26`	`},`
`23`	`27`	`"required": [`