oci

Documentation

Index

• func IsSupported(transport string) string
• 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, ...) error
• type PullOptions

Functions

func IsSupported

func IsSupported(transport string) string

IsSupported returns whether or not the transport given is supported. To fit within a switch/case statement, this function will return transport if it is supported

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, ociAuth *ocitypes.DockerAuthConfig) 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    *ocitypes.DockerAuthConfig
	DockerHost string
	NoHTTPS    bool
	NoCleanUp  bool
	OciSif     bool
	Platform   gccrv1.Platform
}