content

Documentation

Index

• Variables
• func Display(w io.Writer, statuses []StatusInfo, start time.Time)
• func Fetch(ctx context.Context, client *containerd.Client, ref string, ...) (images.Image, error)
• func ShowProgress(ctx context.Context, ongoing *Jobs, cs content.Store, out io.Writer)
• type FetchConfig
  • func NewFetchConfig(ctx context.Context, clicontext *cli.Context) (*FetchConfig, error)
• type Jobs
  • func NewJobs(name string) *Jobs
  • func (j *Jobs) Add(desc ocispec.Descriptor)
  • func (j *Jobs) IsResolved() bool
  • func (j *Jobs) Jobs() []ocispec.Descriptor
• type StatusInfo
• type StatusInfoStatus

Variables

var (
	// Command is the cli command for managing content
	Command = cli.Command{
		Name:  "content",
		Usage: "manage content",
		Subcommands: cli.Commands{
			activeIngestCommand,
			deleteCommand,
			editCommand,
			fetchCommand,
			fetchObjectCommand,
			fetchBlobCommand,
			getCommand,
			ingestCommand,
			listCommand,
			pushObjectCommand,
			setLabelsCommand,
			pruneCommand,
		},
	}
)

Functions

func Display

func Display(w io.Writer, statuses []StatusInfo, start time.Time)

Display pretty prints out the download or upload progress

func Fetch

func Fetch(ctx context.Context, client *containerd.Client, ref string, config *FetchConfig) (images.Image, error)

Fetch loads all resources into the content store and returns the image

func ShowProgress

func ShowProgress(ctx context.Context, ongoing *Jobs, cs content.Store, out io.Writer)

ShowProgress continuously updates the output with job progress by checking status in the content store.

Types

type FetchConfig

type FetchConfig struct {
	// Resolver
	Resolver remotes.Resolver
	// ProgressOutput to display progress
	ProgressOutput io.Writer
	// Labels to set on the content
	Labels []string
	// PlatformMatcher matches platforms, supersedes Platforms
	PlatformMatcher platforms.MatchComparer
	// Platforms to fetch
	Platforms []string
	// Whether or not download all metadata
	AllMetadata bool
	// RemoteOpts to configure object resolutions and transfers with remote content providers
	RemoteOpts []containerd.RemoteOpt
	// TraceHTTP writes DNS and connection information to the log when dealing with a container registry
	TraceHTTP bool
}

FetchConfig for content fetch

func NewFetchConfig

func NewFetchConfig(ctx context.Context, clicontext *cli.Context) (*FetchConfig, error)

NewFetchConfig returns the default FetchConfig from cli flags

type Jobs

type Jobs struct {
	// contains filtered or unexported fields
}

Jobs provides a way of identifying the download keys for a particular task encountering during the pull walk.

This is very minimal and will probably be replaced with something more featured.

func NewJobs

func NewJobs(name string) *Jobs

NewJobs creates a new instance of the job status tracker

func (*Jobs) Add

func (j *Jobs) Add(desc ocispec.Descriptor)

Add adds a descriptor to be tracked

func (*Jobs) IsResolved

func (j *Jobs) IsResolved() bool

IsResolved checks whether a descriptor has been resolved

func (*Jobs) Jobs

func (j *Jobs) Jobs() []ocispec.Descriptor

Jobs returns a list of all tracked descriptors

type StatusInfo

type StatusInfo struct {
	Ref       string
	Status    StatusInfoStatus
	Offset    int64
	Total     int64
	StartedAt time.Time
	UpdatedAt time.Time
}

StatusInfo holds the status info for an upload or download

type StatusInfoStatus

type StatusInfoStatus string

StatusInfoStatus describes status info for an upload or download.

const (
	StatusResolved    StatusInfoStatus = "resolved"
	StatusResolving   StatusInfoStatus = "resolving"
	StatusWaiting     StatusInfoStatus = "waiting"
	StatusCommitting  StatusInfoStatus = "committing"
	StatusDone        StatusInfoStatus = "done"
	StatusDownloading StatusInfoStatus = "downloading"
	StatusUploading   StatusInfoStatus = "uploading"
	StatusExists      StatusInfoStatus = "exists"
)