Skip to content

Add standard base image annotations #822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vbatts merged 4 commits into from
Jul 30, 2021
Merged

Add standard base image annotations #822

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
71ccc68
Add standard base image annotations
imjasonh Feb 18, 2021
4feeaac
Describe how index manifests should work with base image annotations
imjasonh Jun 30, 2021
eaa222c
image.base.ref.name -> image.base.name based on stevvooe's feedback
imjasonh Jul 1, 2021
ebb32fd
Use registry.example.com as example default registry
imjasonh Jul 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ 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)
Comment thread
imjasonh marked this conversation as resolved.
* This SHOULD be the immediate image sharing zero-indexed layers with the image, such as from a Dockerfile `FROM` statement.
Comment thread
imjasonh marked this conversation as resolved.
* This SHOULD NOT reference any other images used to generate the contents of the image (e.g., multi-stage Dockerfile builds).
* **org.opencontainers.image.base.ref.name** Image reference of the image this image is based on (string)
Comment thread
imjasonh marked this conversation as resolved.
Outdated
* This SHOULD be image references in the format defined by [distribution/distribution](https://github.com/distribution/distribution/blob/d0deff9cd6c2b8c82c6f3d1c713af51df099d07b/reference/reference.go).
* This SHOULD be a fully qualified reference name, without any assumed default registry. (e.g., `index.docker.io/my-org/my-image:tag` instead of `my-org/my-image:tag`).
Comment thread
imjasonh marked this conversation as resolved.
Outdated
* This SHOULD be the immediate image sharing zero-indexed layers with the image, such as from a Dockerfile `FROM` statement.
* This SHOULD NOT reference any other images used to generate the contents of the image (e.g., multi-stage Dockerfile builds).
* If the `image.base.ref.name` annotation is specified, the `image.base.digest` annotation SHOULD be the digest of the manifest referenced by the `image.base.ref.name` annotation.

## Back-compatibility with Label Schema

Expand Down
6 changes: 6 additions & 0 deletions specs-go/v1/annotations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,10 @@ const (

// AnnotationDescription is the annotation key for the human-readable description of the software packaged in the image.
AnnotationDescription = "org.opencontainers.image.description"

// AnnotationBaseImageDigest is the annotation key for the digest of the image's base image.
AnnotationBaseImageDigest = "org.opencontainers.image.base.digest"

// AnnotationBaseImageRefName is the annotation key for the image reference of the image's base image.
AnnotationBaseImageRefName = "org.opencontainers.image.base.ref.name"
Comment thread
imjasonh marked this conversation as resolved.
Outdated
)