Module oci_spec::image [−][src]
Expand description
OCI image spec types and definitions.
Structs
The execution parameters which SHOULD be used as a base when running a container using the image.
A Content Descriptor (or simply Descriptor) describes the disposition of the targeted content. It includes the type of the content, a content identifier (digest), and the byte-size of the raw content. Descriptors SHOULD be embedded in other formats to securely reference external content.
Describes the history of a layer.
The image configuration is associated with an image and describes some basic information about the image such as date created, author, as well as execution/runtime configuration like its entrypoint, default arguments, networking, and volumes.
The image index is a higher-level manifest which points to specific image manifests, ideal for one or more platforms. While the use of an image index is OPTIONAL for image providers, image consumers SHOULD be prepared to process them.
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.
Describes the minimum runtime requirements of the image.
RootFs references the layer content addresses used by the image.
Constants
AnnotationAuthors is the annotation key for the contact details of the people or organization responsible for the image (freeform string).
AnnotationBaseImageDigest is the annotation key for the digest of the image’s base image.
AnnotationBaseImageName is the annotation key for the image reference of the image’s base image.
AnnotationCreated is the annotation key for the date and time on which the image was built (date-time string as defined by RFC 3339).
AnnotationDescription is the annotation key for the human-readable description of the software packaged in the image.
AnnotationDocumentation is the annotation key for the URL to get documentation on the image.
AnnotationLicenses is the annotation key for the license(s) under which contained software is distributed as an SPDX License Expression.
AnnotationRefName is the annotation key for the name of the reference for a
target. SHOULD only be considered valid when on descriptors on index.json
within image layout.
AnnotationRevision is the annotation key for the source control revision identifier for the packaged software.
AnnotationSource is the annotation key for the URL to get source code for building the image.
AnnotationTitle is the annotation key for the human-readable title of the image.
AnnotationURL is the annotation key for the URL to find more information on the image.
AnnotationVendor is the annotation key for the name of the distributing entity, organization or individual.
AnnotationVersion is the annotation key for the version of the packaged software. The version MAY match a label or tag in the source code repository. The version MAY be Semantic versioning-compatible.