Module ostree_ext::container::store

APIs for storing (layered) container images as OSTree commits

Extension of encapsulation support

This code supports ingesting arbitrary layered container images from an ostree-exported base. See encapsulate for more information on encaspulation of images.

Structs

• CachedImageUpdate
  Locally cached metadata for an update to an existing image.
• ImageImporter
  Context for importing a container image.
• ImageProxyConfig
  Configuration for the proxy.
• LayerProgress
  Sent across a channel to track the byte-level progress of a layer fetch.
• LayeredImageState
  State of an already pulled layered image.
• ManifestLayerState
  A container image layer with associated downloaded-or-not state.
• PreparedImport
  Information about which layers need to be downloaded.

Enums

• ImportProgress
  Sent across a channel to track start and end of a container fetch.
• PrepareResult
  Result of invoking ImageImporter::prepare.

Constants

• BASE_IMAGE_PREFIX
  The ostree ref prefix for “base” image references that are used by derived images. If you maintain tooling which is locally building derived commits, write a ref with this prefix that is owned by your code. It’s a best practice to prefix the ref with the project name, so the final ref may be of the form e.g. ostree/container/baseimage/bootc/foo.
• META_FILTERED
  Value of type a{sa{su}} containing number of filtered out files

Functions

• copy
  Copy a downloaded image from one repository to another, while also optionally changing the image reference type.
• gc_image_layers
  Garbage collect unused image layer references.
• image_filtered_content_warning
  Given an image, if it has any non-ostree compatible content, return a suitable warning message.
• list_images
  List all images stored
• manifest_digest_from_commit
  Return the original digest of the manifest stored in the commit metadata. This will be a string of the form e.g. sha256:<digest>.
• query_image
  Query metadata for a pulled image.
• query_image_commit
  Query metadata for a pulled image via an OSTree commit digest. The digest must refer to a pulled container image’s merge commit.
• remove_image
  Remove the specified image reference. If the image is already not present, this function will successfully perform no operation.
• remove_images
  Remove the specified image references. If an image is not found, further images will be removed, but an error will be returned.

Type Aliases

• MetaFilteredData
  The type used to store content filtering information with META_FILTERED.