ocibuild_manifest (ocibuild v0.10.4)

View Source

OCI image manifest builder.

The manifest ties together the config and layers that make up an image. Compliant with the OCI Image Specification.

See: https://github.com/opencontainers/image-spec/blob/main/manifest.md

Summary

Types

descriptor()
manifest()

Functions

build(ConfigDescriptor, LayerDescriptors)

Build an OCI image manifest from config and layer descriptors.

build(ConfigDescriptor, LayerDescriptors, Annotations)

Build an OCI image manifest from config and layer descriptors with annotations.

config_media_type()

OCI image config media type.

layer_media_type()

OCI layer media type (gzip compressed).

layer_media_type/1

OCI layer media type for specified compression.

media_type()

OCI image manifest media type.

Types

descriptor()

-type descriptor() :: #{binary() := binary() | non_neg_integer()}.

manifest()

-type manifest() :: #{binary() := integer() | binary() | descriptor() | [descriptor()] | map()}.

Functions

build(ConfigDescriptor, LayerDescriptors)

-spec build(descriptor(), [descriptor()]) -> {binary(), binary()}.

Build an OCI image manifest from config and layer descriptors.

build(ConfigDescriptor, LayerDescriptors, Annotations)

-spec build(descriptor(), [descriptor()], map()) -> {binary(), binary()}.

Build an OCI image manifest from config and layer descriptors with annotations.

config_media_type()

-spec config_media_type() -> binary().

OCI image config media type.

layer_media_type()

-spec layer_media_type() -> binary().

OCI layer media type (gzip compressed).

layer_media_type/1

-spec layer_media_type(gzip | zstd | none) -> binary().

OCI layer media type for specified compression.

media_type()

-spec media_type() -> binary().

OCI image manifest media type.