ociimage

Documentation

Index

• func CheckPerms(rootfs string) (err error)
• func FetchToLayout(ctx context.Context, tOpts *TransportOptions, imgCache *cache.Handle, ...) (ggcrv1.Image, error)
• func FixPerms(rootfs string) (err error)
• func ImageDigest(ctx context.Context, tOpts *TransportOptions, imgCache *cache.Handle, ...) (ggcrv1.Hash, error)
• func SupportedTransport(transport string) string
• func UnpackRootfs(_ context.Context, srcImage v1.Image, destDir string) (err error)
• type SourceSink
  • func URItoSourceSinkRef(imageURI string) (SourceSink, string, error)
  • func (ss SourceSink) Image(ctx context.Context, ref string, tOpts *TransportOptions, ...) (v1.Image, error)
  • func (ss SourceSink) Reference(s string, tOpts *TransportOptions) (name.Reference, bool)
  • func (ss SourceSink) WriteImage(img v1.Image, dstName string, tOpts *TransportOptions) error
• type TransportOptions
  • func TransportOptionsFromSystemContext(sc *types.SystemContext) *TransportOptions
  • func (t *TransportOptions) SystemContext() types.SystemContext

Functions

func CheckPerms

func CheckPerms(rootfs string) (err error)

CheckPerms will work through the rootfs of this bundle, and find if any directory does not have owner rwX - which may cause unexpected issues for a user trying to look through, or delete a sandbox

func FetchToLayout

func FetchToLayout(ctx context.Context, tOpts *TransportOptions, imgCache *cache.Handle, imageURI, tmpDir string) (ggcrv1.Image, error)

FetchToLayout will fetch the OCI image specified by imageRef to an OCI layout and return a v1.Image referencing it. If imgCache is non-nil, and enabled, the image will be fetched into Singularity's cache - which is a multi-image OCI layout. If the cache is disabled, the image will be fetched into a subdirectory of the provided tmpDir. The caller is responsible for cleaning up tmpDir.

func FixPerms

func FixPerms(rootfs string) (err error)

FixPerms will work through the rootfs of this bundle, making sure that all files and directories have permissions set such that the owner can read, modify, delete. This brings us to the situation of <=3.4

func ImageDigest

func ImageDigest(ctx context.Context, tOpts *TransportOptions, imgCache *cache.Handle, uri string) (ggcrv1.Hash, error)

ImageDigest obtains the digest of the image manifest for a uri-like image reference. If the reference points to a multi-arch repository with an image index (manifest list), it will traverse this to retrieve the digest of the image manifest for the requested architecture specified in tOpts.

func SupportedTransport

func SupportedTransport(transport string) string

SupportedTransport 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 UnpackRootfs

func UnpackRootfs(_ context.Context, srcImage v1.Image, destDir string) (err error)

UnpackRootfs extracts all of the layers of the given srcImage into destDir.

Types

type SourceSink

type SourceSink int

const (
	UnknownSourceSink SourceSink = iota
	RegistrySourceSink
	OCISourceSink
	TarballSourceSink
	DaemonSourceSink
)

func URItoSourceSinkRef

func URItoSourceSinkRef(imageURI string) (SourceSink, string, error)

URItoSourceSinkRef parses a uri-like OCI image reference into a SourceSink and ref

func (SourceSink) Image

func (ss SourceSink) Image(ctx context.Context, ref string, tOpts *TransportOptions, rt *progress.RoundTripper) (v1.Image, error)

func (SourceSink) Reference

func (ss SourceSink) Reference(s string, tOpts *TransportOptions) (name.Reference, bool)

func (SourceSink) WriteImage

func (ss SourceSink) WriteImage(img v1.Image, dstName string, tOpts *TransportOptions) error

type TransportOptions

type TransportOptions struct {
	// AuthConfig provides optional credentials to be used when interacting with
	// an image transport.
	AuthConfig *authn.AuthConfig
	// AuthFilePath provides an optional path to a file containing credentials
	// to be used when interacting with an image transport.
	AuthFilePath string
	// Insecure should be set to true in order to interact with a registry via
	// http, or without TLS certificate verification.
	Insecure bool
	// DockerDaemonHost provides the URI to use when interacting with a Docker
	// daemon.
	DockerDaemonHost string
	// Platform specifies the OS / Architecture / Variant that the pulled images
	// should satisfy.
	Platform v1.Platform
	// UserAgent will be set on HTTP(S) request made by transports.
	UserAgent string
	// TmpDir is a location in which a transport can create temporary files.
	TmpDir string
}

TransportOptions provides authentication, platform etc. configuration for interactions with image transports.

func TransportOptionsFromSystemContext

func TransportOptionsFromSystemContext(sc *types.SystemContext) *TransportOptions

TransportOptionsFromSystemContext returns a TransportOptions struct initialized from a containers/image SystemContext. If the SystemContext is nil, then nil is returned.

Deprecated: for containers/image compatibility only. To be removed in SingularityCE v5.

func (*TransportOptions) SystemContext

func (t *TransportOptions) SystemContext() types.SystemContext

SystemContext returns a containers/image/v5 types.SystemContext struct for compatibility with operations that still use containers/image.

Deprecated: for containers/image compatibility only. To be removed in SingularityCE v5.