oci

Documentation

Index

• Constants
• func BuildImageFromLayer(layer v1.Layer, ic types.ImageConfiguration, created time.Time, ...) (oci.SignedImage, error)
• func BuildImageTarballFromLayer(imageRef string, layer v1.Layer, outputTarGZ string, ...) error
• func BuildIndex(outfile string, idx oci.SignedImageIndex, tags []string, logger log.Logger) (name.Digest, error)
• func Copy(ctx context.Context, src, dst string, remoteOpts ...remote.Option) error
• func GenerateDockerIndex(ctx context.Context, ic types.ImageConfiguration, ...) (name.Digest, oci.SignedImageIndex, error)
• func GenerateIndex(ctx context.Context, ic types.ImageConfiguration, ...) (name.Digest, oci.SignedImageIndex, error)
• func LoadImage(ctx context.Context, image oci.SignedImage, logger log.Logger, tags []string) (name.Reference, error)
• func LoadIndex(ctx context.Context, idx oci.SignedImageIndex, logger log.Logger, ...) (name.Reference, error)
• func PostAttachSBOM(ctx context.Context, si oci.SignedEntity, sboms []types.SBOM, ...) (oci.SignedEntity, error)
• func PostAttachSBOMsFromIndex(ctx context.Context, idx oci.SignedImageIndex, sboms []types.SBOM, ...) error
• func PublishImage(ctx context.Context, image oci.SignedImage, shouldPushTags bool, ...) (name.Digest, error)
• func PublishImagesFromIndex(ctx context.Context, idx oci.SignedImageIndex, logger log.Logger, ...) ([]name.Digest, error)
• func PublishIndex(ctx context.Context, idx oci.SignedImageIndex, logger log.Logger, ...) (name.Digest, error)

Constants

const (
	LocalDomain = "apko.local"
	LocalRepo   = "cache"
)

Functions

func BuildImageFromLayer

func BuildImageFromLayer(layer v1.Layer, ic types.ImageConfiguration, created time.Time, arch types.Architecture, logger log.Logger) (oci.SignedImage, error)

func BuildImageTarballFromLayer

func BuildImageTarballFromLayer(imageRef string, layer v1.Layer, outputTarGZ string, ic types.ImageConfiguration, logger log.Logger, opts options.Options) error

func BuildIndex

func BuildIndex(outfile string, idx oci.SignedImageIndex, tags []string, logger log.Logger) (name.Digest, error)

BuildIndex builds a self-contained tar.gz file containing the index and its individual images for all architectures. Returns the digest and the path to the combined tar.gz.

func Copy

func Copy(ctx context.Context, src, dst string, remoteOpts ...remote.Option) error

Copt copies an image from one registry repository to another.

func GenerateDockerIndex

func GenerateDockerIndex(ctx context.Context, ic types.ImageConfiguration, imgs map[types.Architecture]oci.SignedImage) (name.Digest, oci.SignedImageIndex, error)

GenerateDockerIndex generates a docker multi-arch manifest from the given imgs. The index type will be "application/vnd.docker.distribution.manifest.list.v2+json". The index is stored in memory.

func GenerateIndex

func GenerateIndex(ctx context.Context, ic types.ImageConfiguration, imgs map[types.Architecture]oci.SignedImage) (name.Digest, oci.SignedImageIndex, error)

GenerateIndex generates an OCI image index from the given imgs. The index type will be "application/vnd.oci.image.index.v1+json". The index is stored in memory.

func LoadImage

func LoadImage(ctx context.Context, image oci.SignedImage, logger log.Logger, tags []string) (name.Reference, error)

func LoadIndex

func LoadIndex(ctx context.Context, idx oci.SignedImageIndex, logger log.Logger, tags []string) (name.Reference, error)

If attempting to save locally, pick the native architecture and use that cached image for local tags Ported from https://github.com/ko-build/ko/blob/main/pkg/publish/daemon.go#L92-L168

func PostAttachSBOM

func PostAttachSBOM(ctx context.Context, si oci.SignedEntity, sboms []types.SBOM,
	platform *v1.Platform, logger log.Logger, tags []string, remoteOpts ...remote.Option) (oci.SignedEntity, error)

PostAttachSBOM attaches the sboms to a single already published image

func PostAttachSBOMsFromIndex

func PostAttachSBOMsFromIndex(ctx context.Context, idx oci.SignedImageIndex, sboms []types.SBOM,
	logger log.Logger, tags []string, remoteOpts ...remote.Option) error

PostAttachSBOMsFromIndex attaches SBOMs to an already published index and all of the referenced images

func PublishImage

func PublishImage(ctx context.Context, image oci.SignedImage, shouldPushTags bool, logger log.Logger, tags []string, remoteOpts ...remote.Option) (name.Digest, error)

PublishImage publishes an image to a registry. `local` determines if it should push to the local docker daemon or to the actual registry. `shouldPushTags` determines whether to push the tags provided in the `tags` parameter, or whether to treat the first tag as a digest and push that instead.

func PublishImagesFromIndex

func PublishImagesFromIndex(ctx context.Context, idx oci.SignedImageIndex, logger log.Logger, repo name.Repository, remoteOpts ...remote.Option) ([]name.Digest, error)

PublishImagesFromIndex publishes all images from an index to a remote registry. The only difference between this and PublishIndex is that PublishIndex pushes out all blobs and referenced manifests from within the index. This adds pushing the referenced SignedImage artifacts along with appropriate tags.

func PublishIndex

func PublishIndex(ctx context.Context, idx oci.SignedImageIndex, logger log.Logger, shouldPushTags bool, tags []string, remoteOpts ...remote.Option) (name.Digest, error)

PublishIndex given an oci.SignedImageIndex, publish it to a registry. `local` causes it to publish to the local docker daemon instead of the registry. Note that docker, when provided with a multi-architecture index, will load just the image inside for the provided platform, defaulting to the one on which the docker daemon is running. PublishIndex will determine that platform and use it to publish the updated index.