Documentation
¶
Index ¶
- Variables
- func FilterByLabel(ctx context.Context, client *containerd.Client, imageList []images.Image, ...) ([]images.Image, error)
- func FilterByReference(imageList []images.Image, filters []string) ([]images.Image, error)
- func FilterDangling(imageList []images.Image, dangling bool) []images.Image
- func FilterImages(labelImages []images.Image, beforeImages []images.Image, ...) []images.Image
- 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)
- func UnpackedImageSize(ctx context.Context, s snapshots.Snapshotter, img containerd.Image) (int64, 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 Filters
- type PullMode
Constants ¶
This section is empty.
Variables ¶
var ( FilterBeforeType = "before" FilterSinceType = "since" FilterLabelType = "label" FilterReferenceType = "reference" FilterDanglingType = "dangling" )
Filter types supported to filter images.
Functions ¶
func FilterByLabel ¶
func FilterByLabel(ctx context.Context, client *containerd.Client, imageList []images.Image, filters map[string]string) ([]images.Image, error)
FilterByLabel filters images based on labels given in `filters`.
func FilterByReference ¶
FilterByReference filters images using references given in `filters`.
func FilterDangling ¶
FilterDangling filters dangling images (or keeps if `dangling` == false).
func FilterImages ¶
func FilterImages(labelImages []images.Image, beforeImages []images.Image, sinceImages []images.Image) []images.Image
FilterImages returns images in `labelImages` that are created before MAX(beforeImages.CreatedAt) and after MIN(sinceImages.CreatedAt).
func ParseRepoTag ¶
ParseRepoTag parses raw `imgName` to repository and tag.
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 image index, or 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, or nil if no manifest was found.
func ResolveDigest ¶
func ResolveDigest(ctx context.Context, rawRef string, insecure bool, hostsDirs []string) (string, error)
ResolveDigest resolves `rawRef` and returns its descriptor digest.
func UnpackedImageSize ¶
func UnpackedImageSize(ctx context.Context, s snapshots.Snapshotter, img containerd.Image) (int64, error)
UnpackedImageSize is the size of the unpacked snapshots. Does not contain the size of the blobs in the content store. (Corresponds to Docker).
Types ¶
type EnsuredImage ¶
type EnsuredImage struct {
Ref string
Image containerd.Image
ImageConfig ocispec.ImageConfig
Snapshotter string
Remote bool // true for stargz or overlaybd
}
EnsuredImage contains the image existed in containerd and its metadata.
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, rFlags types.RemoteSnapshotterFlags) (*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. 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, rFlags types.RemoteSnapshotterFlags) (*EnsuredImage, error)
PullImage pulls an image using the specified resolver.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package pull forked from https://github.com/containerd/containerd/blob/v1.4.3/cmd/ctr/commands/content/fetch.go
|
Package pull forked from https://github.com/containerd/containerd/blob/v1.4.3/cmd/ctr/commands/content/fetch.go |
|
Package push derived from https://github.com/containerd/containerd/blob/v1.4.3/cmd/ctr/commands/images/push.go
|
Package push derived from https://github.com/containerd/containerd/blob/v1.4.3/cmd/ctr/commands/images/push.go |