image

Documentation

Index

• Constants
• type GuessedRefParts
  • func NewGuessedRefParts(ref string) GuessedRefParts
• type Imgpkg
  • func NewImgpkg(opts ImgpkgOpts, refFetcher ctlfetch.RefFetcher, c ctlcache.Cache) *Imgpkg
  • func (t *Imgpkg) FetchBundle(imageRef, destination string) (string, error)
  • func (t *Imgpkg) FetchBundleRecursively(imageRef, destination string) (string, error)
  • func (t *Imgpkg) FetchImage(imageRef, destination string) (string, error)
  • func (t *Imgpkg) RegistryOpts() (registry.Opts, error)
  • func (t *Imgpkg) Tags(repo string) ([]string, error)
• type ImgpkgOpts
• type Logger
  • func (l *Logger) Debugf(string, ...interface{})
  • func (l *Logger) Errorf(msg string, args ...interface{})
  • func (l *Logger) Logf(msg string, args ...interface{})
  • func (l *Logger) Tracef(string, ...interface{})
  • func (l *Logger) Warnf(msg string, args ...interface{})
• type Sync
  • func NewSync(opts ctlconf.DirectoryContentsImage, refFetcher ctlfetch.RefFetcher, ...) *Sync
  • func (t Sync) Desc() string
  • func (t *Sync) Sync(dstPath string) (ctlconf.LockDirectoryContentsImage, error)

Constants

const (
	ImgpkgBundleArtifactType = "imgpkgBundle"
	ImageArtifactType        = "image"
)

Types

type GuessedRefParts

type GuessedRefParts struct {
	Repo   string
	Tag    string
	Digest string
}

GuessedRefParts represents an image ref that was guessed from a string. it may not be an accurate representation since imgpkg parses ref itself. (Did not want to use go-containerregistry to avoid taking extra dep)

func NewGuessedRefParts

func NewGuessedRefParts(ref string) GuessedRefParts

type Imgpkg

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

func NewImgpkg

func NewImgpkg(opts ImgpkgOpts, refFetcher ctlfetch.RefFetcher, c ctlcache.Cache) *Imgpkg

func (*Imgpkg) FetchBundle

func (t *Imgpkg) FetchBundle(imageRef, destination string) (string, error)

FetchBundle Downloads the Bundle to the provided destination

func (*Imgpkg) FetchBundleRecursively

func (t *Imgpkg) FetchBundleRecursively(imageRef, destination string) (string, error)

FetchBundleRecursively Download the Bundle and all the nested Bundles to the provided destination

func (*Imgpkg) FetchImage

func (t *Imgpkg) FetchImage(imageRef, destination string) (string, error)

FetchImage Downloads the OCI Image to the provided destination

func (*Imgpkg) RegistryOpts

func (t *Imgpkg) RegistryOpts() (registry.Opts, error)

func (*Imgpkg) Tags

func (t *Imgpkg) Tags(repo string) ([]string, error)

type ImgpkgOpts

type ImgpkgOpts struct {
	SecretRef              *ctlconf.DirectoryContentsLocalRef
	DangerousSkipTLSVerify bool

	EnvironFunc func() []string
}

type Logger

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

Logger provided to the imgpkg API calls This logger does write to the buffer debug and trace message. If we want to provide such a mechanism we should provide a way to define what is the level of messages that we want to have present in the buffer

func (*Logger) Debugf

func (l *Logger) Debugf(string, ...interface{})

Debugf does nothing

func (*Logger) Errorf

func (l *Logger) Errorf(msg string, args ...interface{})

Errorf Writes error messages to the buffer

func (*Logger) Logf

func (l *Logger) Logf(msg string, args ...interface{})

Logf Writes messages to the buffer

func (*Logger) Tracef

func (l *Logger) Tracef(string, ...interface{})

Tracef does nothing

func (*Logger) Warnf

func (l *Logger) Warnf(msg string, args ...interface{})

Warnf Writes warning messages to the buffer

type Sync

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

func NewSync

func NewSync(opts ctlconf.DirectoryContentsImage, refFetcher ctlfetch.RefFetcher, c ctlcache.Cache) *Sync

func (Sync) Desc

func (t Sync) Desc() string

func (*Sync) Sync

func (t *Sync) Sync(dstPath string) (ctlconf.LockDirectoryContentsImage, error)