imgutil

Documentation

Index

• func ParseRepoTag(imgName string) (string, string)
• func ReadImageConfig(ctx context.Context, img containerd.Image) (ocispec.Image, ocispec.Descriptor, error)
• func ReadIndex(ctx context.Context, img containerd.Image) (*ocispec.Index, *ocispec.Descriptor, error)
• func ReadManifest(ctx context.Context, img containerd.Image) (*ocispec.Manifest, *ocispec.Descriptor, error)
• func ResolveDigest(ctx context.Context, rawRef string, insecure bool, hostsDirs []string) (string, error)
• type EnsuredImage
  • func EnsureImage(ctx context.Context, client *containerd.Client, stdout, stderr io.Writer, ...) (*EnsuredImage, error)
  • func GetExistingImage(ctx context.Context, client *containerd.Client, snapshotter, rawRef string, ...) (*EnsuredImage, error)
  • func PullImage(ctx context.Context, client *containerd.Client, stdout, stderr io.Writer, ...) (*EnsuredImage, error)
• type PullMode

Functions

func ParseRepoTag

func ParseRepoTag(imgName string) (string, string)

func ReadImageConfig

func ReadImageConfig(ctx context.Context, img containerd.Image) (ocispec.Image, ocispec.Descriptor, error)

ReadImageConfig reads the config spec (`application/vnd.oci.image.config.v1+json`) for img.platform from content store.

func ReadIndex

func ReadIndex(ctx context.Context, img containerd.Image) (*ocispec.Index, *ocispec.Descriptor, error)

ReadIndex returns the index . ReadIndex returns nil for non-indexed image.

func ReadManifest

func ReadManifest(ctx context.Context, img containerd.Image) (*ocispec.Manifest, *ocispec.Descriptor, error)

ReadManifest returns the manifest for img.platform. ReadManifest returns nil if no manifest was found.

func ResolveDigest

func ResolveDigest(ctx context.Context, rawRef string, insecure bool, hostsDirs []string) (string, error)

Types

type EnsuredImage

type EnsuredImage struct {
	Ref         string
	Image       containerd.Image
	ImageConfig ocispec.ImageConfig
	Snapshotter string
	Remote      bool // true for stargz or overlaybd
}

func EnsureImage

func EnsureImage(ctx context.Context, client *containerd.Client, stdout, stderr io.Writer, snapshotter, rawRef string, mode PullMode, insecure bool, hostsDirs []string, ocispecPlatforms []ocispec.Platform, unpack *bool, quiet bool) (*EnsuredImage, error)

EnsureImage ensures the image.

When insecure is set, skips verifying certs, and also falls back to HTTP when the registry does not speak HTTPS

FIXME: this func has too many args

func GetExistingImage

func GetExistingImage(ctx context.Context, client *containerd.Client, snapshotter, rawRef string, platform ocispec.Platform) (*EnsuredImage, error)

GetExistingImage returns the specified image if exists in containerd. May return errdefs.NotFound() if not exists.

func PullImage

func PullImage(ctx context.Context, client *containerd.Client, stdout, stderr io.Writer, snapshotter string, resolver remotes.Resolver, ref string, ocispecPlatforms []ocispec.Platform, unpack *bool, quiet bool) (*EnsuredImage, error)

PullImage pulls an image using the specified resolver.

type PullMode

type PullMode = string

PullMode is either one of "always", "missing", "never"