converter

Documentation

Index

• type ConvertOpt
  • func WithAnnotation(annotations map[string]string) ConvertOpt
  • func WithDriver(typ string, config map[string]string) ConvertOpt
  • func WithPlatform(platformMC platforms.MatchComparer) ConvertOpt
  • func WithProvider(provider content.Provider) ConvertOpt
• type ConvertOpts
• type Converter
  • func New(opts ...ConvertOpt) (*Converter, error)
  • func (cvt *Converter) Convert(ctx context.Context, source, target, cacheRef string) (*Metric, error)
• type Metric
  • func (metric *Metric) SetSourceImageSize(ctx context.Context, cvt *Converter, source string) error
  • func (metric *Metric) SetTargetImageSize(ctx context.Context, cvt *Converter, desc *ocispec.Descriptor) error

Types

type ConvertOpt

type ConvertOpt func(opts *ConvertOpts) error

func WithAnnotation

func WithAnnotation(annotations map[string]string) ConvertOpt

WithAnnotation appends extra annotations for each target image manifest.

func WithDriver

func WithDriver(typ string, config map[string]string) ConvertOpt

WithDriver specifies the conversion driver type and config.

func WithPlatform

func WithPlatform(platformMC platforms.MatchComparer) ConvertOpt

WithPlatform specifies the platforms only to convert.

func WithProvider

func WithProvider(provider content.Provider) ConvertOpt

WithDriver specifies the image store provider.

type ConvertOpts

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

type Converter

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

func New

func New(opts ...ConvertOpt) (*Converter, error)

func (*Converter) Convert

func (cvt *Converter) Convert(ctx context.Context, source, target, cacheRef string) (*Metric, error)

type Metric

type Metric struct {
	// Total size of the source image with specified platforms in bytes
	SourceImageSize int64
	// Total size of the target image with specified platforms in bytes
	TargetImageSize int64
	// Elapsed time of pulling source image
	SourcePullElapsed time.Duration
	// Elapsed time of pushing target image
	ConversionElapsed time.Duration
	// Elapsed time of converting source image to target image
	TargetPushElapsed time.Duration
}

Metric collected the metrics of conversion progress

func (*Metric) SetSourceImageSize

func (metric *Metric) SetSourceImageSize(ctx context.Context, cvt *Converter, source string) error

func (*Metric) SetTargetImageSize

func (metric *Metric) SetTargetImageSize(ctx context.Context, cvt *Converter, desc *ocispec.Descriptor) error