NAME
ocifbsd_image —
ocifbsd OCI image management
library
SYNOPSIS
#include
<ocifbsd/image/pull.h>
#include
<ocifbsd/image/push.h>
#include
<ocifbsd/image/unpack.h>
#include
<ocifbsd/image/zfs_store.h>
DESCRIPTION
The ocifbsd_image library implements the
OCI image lifecycle used by ocifbsd(8) to pull, unpack, store, and push container images. It is
not a standalone program; it is linked into the main
ocifbsd(8) binary and any
external tooling that needs to move images in and out of the local
ZFS-backed image store.
The library provides four functional areas:
- Registry client (pull.c) implements OCI Distribution Spec v1.1 pull and push flows, including bearer-token authentication, manifest and config fetch, and sha256 layer verification.
- Layer unpacker (unpack.c) extracts gz, bz2, xz, and zstd layer tarballs into the destination root, with whiteout handling that matches the OCI image-spec semantics (.wh. and .wh..wh..opq).
- Push pipeline (push.c) creates layer tarballs from local directories, builds OCI image manifests, and drives the chunked cross-mount blob upload protocol.
- ZFS storage backend (zfs_store.c) manages the on-disk dataset layout under OCIFBSD_ZFS_IMAGES, OCIFBSD_ZFS_LAYERS, and OCIFBSD_ZFS_VOLUMES, including clone-based layer sharing, snapshots, send and recv for image migration, and quota accounting.
The public API is declared across
<ocifbsd/image/pull.h>,
<ocifbsd/image/push.h>,
<ocifbsd/image/unpack.h>,
and
<ocifbsd/image/zfs_store.h>;
see those headers for the full list of functions and data structures.
FILES
- /var/db/ocifbsd/images
- Default ZFS dataset for pulled image roots.
- /var/db/ocifbsd/layers
- Default ZFS dataset for shared layer blobs.
- /var/db/ocifbsd/volumes
- Default ZFS dataset for named volumes.
- /etc/ocifbsd/image.conf
- Image configuration (default registry, pull policy).
SEE ALSO
ocifbsd(8), zfs(8), libarchive(3), curl(1), oci-image-spec(7)
HISTORY
The ocifbsd_image library first appeared
in FreeBSD 16.0.
AUTHORS
The ocifbsd_image library was developed by
Klara, Inc. under sponsorship from