From 09eb802e02c44cdd2cabfef90f6c4da5177a907d Mon Sep 17 00:00:00 2001 From: Jason Hall Date: Thu, 18 Feb 2021 09:12:33 -0500 Subject: [PATCH] Add standard base image annotations Signed-off-by: Jason Hall --- annotations.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/annotations.md b/annotations.md index 0c7ad0aa1..2ccc4cb10 100644 --- a/annotations.md +++ b/annotations.md @@ -40,6 +40,19 @@ This specification defines the following annotation keys, intended for but not l ``` * **org.opencontainers.image.title** Human-readable title of the image (string) * **org.opencontainers.image.description** Human-readable description of the software packaged in the image (string) +* **org.opencontainers.image.base.digest** [Digest](descriptor.md#digests) of the image this image is based on (string) + * For the purposes of this annotation, "base image" SHOULD be defined as an image of N layers, that correspond directly to layers 0-N of the image with this annotation, to form the initial root filesystem of the image. +* **org.opencontainers.image.base.ref.name** Name of the reference for the base image (string) + * For the purposes of this annotation, "base image" SHOULD be defined as an image of N layers, that correspond directly to layers 0-N of the image with this annotation, to form the initial root filesystem of the image. + * SHOULD be a tag reference + * Character set of the value SHOULD conform to alphanum of `A-Za-z0-9` and separator set of `-._:@/+` + * The reference must match the following [grammar](considerations.md#ebnf): + ``` + ref ::= component ("/" component)* + component ::= alphanum (separator alphanum)* + alphanum ::= [A-Za-z0-9]+ + separator ::= [-._:@+] | "--" + ``` ## Back-compatibility with Label Schema