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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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
Types ¶
type PullOptions ¶
type PushOptions ¶ added in v4.2.0
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
// WithCosign sets whether to push any associated cosign signatures when
// pushing an OCI-SIF to a registry.
WithCosign bool
}
PushOptions provides options/configuration that determine the behavior of a push to an OCI registry.
Click to show internal directories.
Click to hide internal directories.