You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This fixes the label schema link since the project is now archived and
certificates are unlikely to be fixed. It also adjusts some markdown
syntax with links at the end and whitespace after headers.
Signed-off-by: Brandon Mitchell <[email protected]>
Copy file name to clipboardexpand all lines: annotations.md
+6-4
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
# Annotations
2
+
2
3
Several components of the specification, like [Image Manifests](manifest.md) and [Descriptors](descriptor.md), feature an optional annotations property, whose format is common and defined in this section.
3
4
4
5
This property contains arbitrary metadata.
@@ -45,15 +46,15 @@ This specification defines the following annotation keys, intended for but not l
45
46
* This SHOULD be the immediate image sharing zero-indexed layers with the image, such as from a Dockerfile `FROM` statement.
46
47
* This SHOULD NOT reference any other images used to generate the contents of the image (e.g., multi-stage Dockerfile builds).
47
48
* **org.opencontainers.image.base.name** Image reference of the image this image is based on (string)
48
-
* This SHOULD be image references in the format defined by [distribution/distribution](https://github.com/distribution/distribution/blob/d0deff9cd6c2b8c82c6f3d1c713af51df099d07b/reference/reference.go).
49
+
* This SHOULD be image references in the format defined by [distribution/distribution][distribution-reference].
49
50
* This SHOULD be a fully qualified reference name, without any assumed default registry. (e.g., `registry.example.com/my-org/my-image:tag` instead of `my-org/my-image:tag`).
50
51
* This SHOULD be the immediate image sharing zero-indexed layers with the image, such as from a Dockerfile `FROM` statement.
51
52
* This SHOULD NOT reference any other images used to generate the contents of the image (e.g., multi-stage Dockerfile builds).
52
53
* If the `image.base.name` annotation is specified, the `image.base.digest` annotation SHOULD be the digest of the manifest referenced by the `image.ref.name` annotation.
53
54
54
55
## Back-compatibility with Label Schema
55
56
56
-
[Label Schema](https://label-schema.org) defined a number of conventional labels for container images, and these are now superceded by annotations with keys starting **org.opencontainers.image**.
57
+
[Label Schema][label-schema] defined a number of conventional labels for container images, and these are now superceded by annotations with keys starting **org.opencontainers.image**.
57
58
58
59
While users are encouraged to use the **org.opencontainers.image** keys, tools MAY choose to support compatible annotations using the **org.label-schema** prefix as follows.
59
60
@@ -74,6 +75,7 @@ While users are encouraged to use the **org.opencontainers.image** keys, tools M
74
75
| | `schema-version`| No equivalent in the OCI Image Spec |
75
76
| | `docker.*`, `rkt.*` | No equivalent in the OCI Image Spec |
0 commit comments