Expand description
OCI image spec types and definitions.
Structs§
- Artifact
Manifest - The OCI Artifact manifest describes content addressable artifacts in order to store them along side container images in a registry.
- Artifact
Manifest Builder - Builder for
ArtifactManifest. - Config
- The execution parameters which SHOULD be used as a base when running a container using the image.
- Config
Builder - Builder for
Config. - Descriptor
- 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.
- Descriptor
Builder - Builder for
Descriptor. - Digest
- A parsed pair of algorithm:digest as defined by https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests
- History
- Describes the history of a layer.
- History
Builder - Builder for
History. - Image
Configuration - 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.
- Image
Configuration Builder - Builder for
ImageConfiguration. - Image
Index - 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.
- Image
Index Builder - Builder for
ImageIndex. - Image
Manifest - 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.
- Image
Manifest Builder - Builder for
ImageManifest. - OciLayout
- The oci layout JSON object serves as a marker for the base of an Open Container Image Layout and to provide the version of the image-layout in use. The imageLayoutVersion value will align with the OCI Image Specification version at the time changes to the layout are made, and will pin a given version until changes to the image layout are required.
- OciLayout
Builder - Builder for
OciLayout. - Platform
- Describes the minimum runtime requirements of the image.
- Platform
Builder - Builder for
Platform. - RootFs
- RootFs references the layer content addresses used by the image.
- Root
FsBuilder - Builder for
RootFs. - Sha256
Digest - A SHA-256 digest, guaranteed to be 64 lowercase hexadecimal ASCII characters.
Enums§
- Arch
- Name of the CPU target architecture.
- Digest
Algorithm - A digest algorithm; at the current time only SHA-256 is widely used and supported in the ecosystem. Other SHA variants are included as they are noted in the standards. Other digest algorithms may be added in the future, so this structure is marked as non-exhaustive.
- Media
Type - Media types used by OCI image format spec. Values MUST comply with RFC 6838, including the naming requirements in its section 4.2.
- Os
- Name of the target operating system.
Constants§
- ANNOTATION_
AUTHORS - AnnotationAuthors is the annotation key for the contact details of the people or organization responsible for the image (freeform string).
- ANNOTATION_
BASE_ IMAGE_ DIGEST - AnnotationBaseImageDigest is the annotation key for the digest of the image’s base image.
- ANNOTATION_
BASE_ IMAGE_ NAME - AnnotationBaseImageName is the annotation key for the image reference of the image’s base image.
- ANNOTATION_
CREATED - AnnotationCreated is the annotation key for the date and time on which the image was built (date-time string as defined by RFC 3339).
- ANNOTATION_
DESCRIPTION - AnnotationDescription is the annotation key for the human-readable description of the software packaged in the image.
- ANNOTATION_
DOCUMENTATION - AnnotationDocumentation is the annotation key for the URL to get documentation on the image.
- ANNOTATION_
LICENSES - AnnotationLicenses is the annotation key for the license(s) under which contained software is distributed as an SPDX License Expression.
- ANNOTATION_
REF_ NAME - AnnotationRefName is the annotation key for the name of the reference for a
target. SHOULD only be considered valid when on descriptors on
index.jsonwithin image layout. - ANNOTATION_
REVISION - AnnotationRevision is the annotation key for the source control revision identifier for the packaged software.
- ANNOTATION_
SOURCE - AnnotationSource is the annotation key for the URL to get source code for building the image.
- ANNOTATION_
TITLE - AnnotationTitle is the annotation key for the human-readable title of the image.
- ANNOTATION_
URL - AnnotationURL is the annotation key for the URL to find more information on the image.
- ANNOTATION_
VENDOR - AnnotationVendor is the annotation key for the name of the distributing entity, organization or individual.
- ANNOTATION_
VERSION - 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.
- LABEL_
VERSION - In theory, this key is not standard. In practice, it’s used by at least the RHEL UBI images for a long time.
- SCHEMA_
VERSION - The expected schema version; equals 2 for compatibility with older versions of Docker.
- VERSION_
DEV - Indicates development branch. Releases will be empty string.
- VERSION_
MAJOR - API incompatible changes.
- VERSION_
MINOR - Changing functionality in a backwards-compatible manner
- VERSION_
PATCH - Backwards-compatible bug fixes.
Traits§
- ToDocker
V2S2 - Trait to get the Docker Image Manifest V2 Schema 2 media type for an OCI media type
Functions§
- version
- Retrieve the version as string representation.