Internal Corporate Schemas
- org.label-schema.build-date=$BUILD_DATE \
- org.label-schema.name="@freight-trust/$APPLICATIONh" \
- org.label-schema.description="Freight Trust & Clearing Corporation" \
- org.label-schema.url="https://schema.freighttrust.com/" \
- org.label-schema.vcs-ref=$VCS_REF \
- org.label-schema.vcs-url="https://github.com/freight-trust/$VCS_URL" \
- org.label-schema.vendor="Freight Trust & Clearing" \
- org.label-schema.version=$VERSION \
- org.label-schema.schema-version="1.0"
vcs-refs
commit id of when your image was built
build-date
timestamp of when image was built your image
Several components of the specification, like Image Manifests and Descriptors, feature an optional annotations property, whose format is common and defined in this section.
This property contains arbitrary metadata.
com.example.myKey
.org.opencontainers
is reserved for keys defined in Open Container Initiative (OCI) specifications and MUST NOT be used by other specifications and extensions.org.opencontainers.image
namespace are reserved for use in the OCI Image Specification and MUST NOT be used by other specifications and extensions, including other OCI specifications.This specification defines the following annotation keys, intended for but not limited to image index and image manifest authors:
index.json
within image layout.A-Za-z0-9
and separator set of -._:@/+
ref ::= component ("/" component)*
component ::= alphanum (separator alphanum)*
alphanum ::= [A-Za-z0-9]+
separator ::= [-._:@+] | "--"
Label Schema defined a number of conventional labels for container images, and these are now superceded by annotations with keys starting org.opencontainers.image.
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.
org.opencontainers.image prefix |
org.label-schema prefix |
Compatibility notes |
---|---|---|
created |
build-date |
Compatible |
url |
url |
Compatible |
source |
vcs-url |
Compatible |
version |
version |
Compatible |
revision |
vcs-ref |
Compatible |
vendor |
vendor |
Compatible |
title |
name |
Compatible |
description |
description |
Compatible |
documentation |
usage |
Value is compatible if the documentation is located by a URL |
authors |
No equivalent in Label Schema | |
licenses |
No equivalent in Label Schema | |
ref.name |
No equivalent in Label Schema | |
schema-version |
No equivalent in the OCI Image Spec | |
docker.* , rkt.* |
No equivalent in the OCI Image Spec |
There are three main goals of the Image Manifest Specification.
The first goal is content-addressable images, by supporting an image model where the image’s configuration can be hashed to generate a unique ID for the image and its components.
The second goal is to allow multi-architecture images, through a “fat manifest” which references image manifests for platform-specific versions of an image.
In OCI, this is codified in an image index.
The third goal is to be translatable to the OCI Runtime Specification.
This section defines the application/vnd.oci.image.manifest.v1+json
media type.
For the media type(s) that this is compatible with see the matrix.
Unlike the image index, which contains information about a set of images that can span a variety of architectures and operating systems, an image manifest provides a configuration and set of layers for a single container image for a specific architecture and operating system.
schemaVersion
int
This REQUIRED property specifies the image manifest schema version.
For this version of the specification, this MUST be 2
to ensure backward compatibility with older versions of Docker. The value of this field will not change. This field MAY be removed in a future version of the specification.
mediaType
string
This property is reserved for use, to maintain compatibility.
When used, this field contains the media type of this document, which differs from the descriptor use of mediaType
.
config
descriptor
This REQUIRED property references a configuration object for a container, by digest.
Beyond the descriptor requirements, the value has the following additional restrictions:
mediaType
string
This descriptor property has additional restrictions for config
.
Implementations MUST support at least the following media types:
application/vnd.oci.image.config.v1+json
Manifests concerned with portability SHOULD use one of the above media types.
layers
array of objects
Each item in the array MUST be a descriptor.
The array MUST have the base layer at index 0.
Subsequent layers MUST then follow in stack order (i.e. from layers[0]
to layers[len(layers)-1]
).
The final filesystem layout MUST match the result of applying the layers to an empty directory.
The ownership, mode, and other attributes of the initial empty directory are unspecified.
Beyond the descriptor requirements, the value has the following additional restrictions:
mediaType
string
This descriptor property has additional restrictions for layers[]
.
Implementations MUST support at least the following media types:
application/vnd.oci.image.layer.v1.tar
application/vnd.oci.image.layer.v1.tar+gzip
application/vnd.oci.image.layer.nondistributable.v1.tar
application/vnd.oci.image.layer.nondistributable.v1.tar+gzip
Manifests concerned with portability SHOULD use one of the above media types.
An encountered mediaType
that is unknown to the implementation MUST be ignored.
Entries in this field will frequently use the `+gzip` types.
annotations
string-string map
This OPTIONAL property contains arbitrary metadata for the image manifest.
This OPTIONAL property MUST use the annotation rules.
Example showing an image manifest:
{
"schemaVersion": 2,
"config": {
"mediaType": "application/vnd.oci.image.config.v1+json",
"size": 7023,
"digest": "sha256:b5b2b2c507a0944348e0303114d8d93aaaa081732b86451d9bce1f432a537bc7"
},
"layers": [
{
"mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
"size": 32654,
"digest": "sha256:9834876dcfb05cb167a5c24953eba58c4ac89b1adf57f28f2f9d09af107ee8f0"
},
{
"mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
"size": 16724,
"digest": "sha256:3c3a4604a545cdc127456d94e421cd355bca5b528f4a9c1905b15da2eb4a4c6b"
},
{
"mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
"size": 73109,
"digest": "sha256:ec4b8955958665577945c89419d1af06b5f7636b4ac3da7f12184802ad867736"
}
],
"annotations": {
"com.example.key1": "value1",
"com.example.key2": "value2"
}
}