image

Documentation

Index

• func New(ctx context.Context, opts Options) (*extractor.Client, error)
• type Client
  • func (c *Client) Extract() error
  • func (c *Client) Type() string
• type Options
• type Source
  • func NewSource(name string) *Source
  • func (s *Source) HasScheme() bool
  • func (s *Source) Reference() (types.ImageReference, error)
  • func (s *Source) Scheme() string
  • func (s *Source) String() string

Functions

func New

func New(ctx context.Context, opts Options) (*extractor.Client, error)

New creates new image extractor instance

Types

type Client

type Client struct {
	*extractor.Client
	// contains filtered or unexported fields
}

Client represents an active image extractor object

func (*Client) Extract

func (c *Client) Extract() error

Extract extracts a registry image

func (*Client) Type

func (c *Client) Type() string

Type returns the extractor type

type Options

type Options struct {
	// Source image reference
	Source string
	// Platform to enforce for Source image
	Platform specs.Platform
	// Includes a subset of files/dirs from the Source image
	Includes []string
	// All extracts all architectures if Source image is a manifest list
	All bool

	// Dist folder
	Dist string
	// Wrap merges output in Dist folder for a manifest list
	Wrap bool

	// RegistryInsecure allows contacting the registry or docker daemon over
	// HTTP, or HTTPS with failed TLS verification
	RegistryInsecure bool
	// RegistryUserAgent is the User-Agent string to send to the registry
	RegistryUserAgent string

	// CacheDir is the directory where the cache is stored
	CacheDir string
}

Options represents image extractor options

type Source

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

func NewSource

func NewSource(name string) *Source

func (*Source) HasScheme

func (s *Source) HasScheme() bool

func (*Source) Reference

func (s *Source) Reference() (types.ImageReference, error)

func (*Source) Scheme

func (s *Source) Scheme() string

func (*Source) String

func (s *Source) String() string