Reference

Configuration

Models for bakery.yaml

config.BakeryConfigDocument: Model representation of the top-level bakery.yaml configuration document.
config.BakeryConfig: Manager for the bakery.yaml configuration file and operations against the configuration.
config.ImageVersionOS: Model representing a supported operating system for an image version.
config.ImageVersion: Model representing a version of an image.
config.ImageVariant: Model representing a variant of an image.
config.Image: Model representing an image in the bakery configuration.
config.BaseRegistry: Model representing an image registry in the Bakery configuration.
config.Registry: Model representing an image from a registry in the Bakery configuration.
config.Repository: Model representing a project repository in the Bakery configuration.
config.TagPattern: Model representing a tag pattern for images in the Bakery configuration.

Image build targets and plans

image.BakePlan: Represents a JSON bake plan for building Docker images using Docker Bake.
image.ImageTarget: Represents a combination of image variant, image version, and image version OS that make up a target image.
image.ImageTargetContext: Container for contextual path information related to an image target.
image.ImageBuildStrategy: Enumeration for image build strategies.

Protocol for extending bakery with custom tools

Clients for DockerHub and GHCR

registry_management.dockerhub.DockerhubClient
registry_management.dockerhub.clean_registry(): Cleans up images in the specified registry.
registry_management.dockerhub.push_readmes(): Push READMEs to Docker Hub for eligible image targets.
registry_management.ghcr.GHCRClient
registry_management.ghcr.clean_registry(): Cleans up images in the specified registry.
registry_management.ghcr.clean_temporary_artifacts(): Cleans up temporary caches and images that are not tagged or are older than a given timedelta.
registry_management.ghcr.GHCRPackageVersion: Represents a GitHub Container Registry package version.
registry_management.ghcr.GHCRPackageVersionMetadata: Represents metadata for a GitHub Container Registry package version.
registry_management.ghcr.GHCRPackageVersionContainerMetadata: Represents container metadata for a GitHub Container Registry package version.
registry_management.ghcr.GHCRPackageVersions: Represents a list of GitHub Container Registry package versions.

Exception hierarchy