oci

Documentation

Index

• func Pull(ctx context.Context, imgCache *cache.Handle, pullFrom string, opts PullOptions) (imagePath string, err error)
• func PullToFile(ctx context.Context, imgCache *cache.Handle, pullTo, pullFrom string, ...) (imagePath string, err error)
• func Push(ctx context.Context, sourceFile string, destRef string, opts PushOptions) error
• type PullOptions
• type PushOptions

Functions

func Pull

func Pull(ctx context.Context, imgCache *cache.Handle, pullFrom string, opts PullOptions) (imagePath string, err error)

Pull will create a SIF / OCI-SIF image to the cache or direct to a temporary file if cache is disabled

func PullToFile

func PullToFile(ctx context.Context, imgCache *cache.Handle, pullTo, pullFrom string, opts PullOptions) (imagePath string, err error)

PullToFile will create a SIF / OCI-SIF image from the specified oci URI and place it at the specified dest

func Push

func Push(ctx context.Context, sourceFile string, destRef string, opts PushOptions) error

Push pushes an image into an OCI registry, as an OCI image (not an ORAS artifact). At present, only OCI-SIF images can be pushed in this manner.

Types

type PullOptions

type PullOptions struct {
	TmpDir      string
	OciAuth     *authn.AuthConfig
	DockerHost  string
	NoHTTPS     bool
	NoCleanUp   bool
	OciSif      bool
	KeepLayers  bool
	Platform    gccrv1.Platform
	ReqAuthFile string
}

type PushOptions

type PushOptions struct {
	// Auth provides optional explicit credentials for OCI registry authentication.
	Auth *authn.AuthConfig
	// AuthFile provides a path to a file containing OCI registry credentials.
	AuthFile string
	// LayerFormat sets an explicit layer format to use when pushing an OCI
	// image. Either 'squashfs' or 'tar'. If unset, layers are pushed as
	// squashfs.
	LayerFormat string
	// TmpDir is a temporary directory to be used for an temporary files created
	// during the push.
	TmpDir string
}

PushOptions provides options/configuration that determine the behavior of a push to an OCI registry.