registry

Documentation

Overview

Package registry defines a Registry interface and client for working for imkpkg images.

Index

• type Registry
  • func New(opts *ctlimg.Opts) (Registry, error)

Types

type Registry

type Registry interface {
	// ListImageTags lists all tags of the given image.
	ListImageTags(imageName string) ([]string, error)
	// GetFile gets the file content bundled in the given image:tag.
	// If filename is empty, it will get the first file.
	GetFile(imageWithTag string, filename string) ([]byte, error)
	// GetFiles get all the files content bundled in the given image:tag.
	GetFiles(imageWithTag string) (map[string][]byte, error)
	// DownloadBundle downloads OCI bundle similar to `imgpkg pull -b` command
	// It is recommended to use this function when downloading imgpkg bundle
	DownloadBundle(imageName, outputDir string) error
	// DownloadImage downloads an OCI image similarly to the `imgpkg pull -i` command
	DownloadImage(imageName, outputDir string) error
	// GetImageDigest gets the digest of an OCI image similar to the `imgpkg tag resolve -i` command
	GetImageDigest(imageWithTag string) (string, string, error)
}

Registry defines the Registry interface

func New

func New(opts *ctlimg.Opts) (Registry, error)

New instantiates a new Registry