fetch

Documentation

Overview

Package fetch provides information retrieval, mostly by wrapping vendir.

Index

• func ExtractImageRegistry(name string) string
• type Factory
  • func NewFactory(coreClient kubernetes.Interface, vendirOpts VendirOpts, ...) Factory
  • func (f Factory) NewInline(opts v1alpha1.AppFetchInline, nsName string) *Inline
  • func (f Factory) NewVendir(nsName string) *Vendir
• type Inline
  • func NewInline(opts v1alpha1.AppFetchInline, nsName string, coreClient kubernetes.Interface) *Inline
  • func (t *Inline) Retrieve(dstPath string) error
• type SkipTLSConfig
• type Vendir
  • func NewVendir(nsName string, coreClient kubernetes.Interface, opts VendirOpts, ...) *Vendir
  • func (v *Vendir) AddDir(fetch v1alpha1.AppFetch, dirPath string) error
  • func (v *Vendir) ClearCache(cacheID string) error
  • func (v *Vendir) Config() vendirconf.Config
  • func (v *Vendir) ConfigBytes() ([]byte, error)
  • func (v *Vendir) Run(conf []byte, workingDir string, cacheID string) exec.CmdRunResult
• type VendirOpts

Functions

func ExtractImageRegistry

func ExtractImageRegistry(name string) string

ExtractImageRegistry returns the registry portion of a Docker image reference

Types

type Factory

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

Factory allows to build various fetchers. At this point most of the fetching is performed via vendir.

func NewFactory

func NewFactory(coreClient kubernetes.Interface, vendirOpts VendirOpts, cmdRunner exec.CmdRunner) Factory

NewFactory returns a Factory.

func (Factory) NewInline

func (f Factory) NewInline(opts v1alpha1.AppFetchInline, nsName string) *Inline

func (Factory) NewVendir

func (f Factory) NewVendir(nsName string) *Vendir

TODO: pass v1alpha1.Vendir opts here once api is exapnded

type Inline

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

Inline struct helps you fetch files or strings from a storage location such as a configmap or secret. For an example if you had a controller in your cluster that generated certs and stored them in a configmap or secret, you could use this inline fetcher to retrieve those certs to pass them on to a templating step.

func NewInline

func NewInline(opts v1alpha1.AppFetchInline, nsName string, coreClient kubernetes.Interface) *Inline

func (*Inline) Retrieve

func (t *Inline) Retrieve(dstPath string) error

type SkipTLSConfig

type SkipTLSConfig interface {
	ShouldSkipTLSForAuthority(authority string) bool
}

type Vendir

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

func NewVendir

func NewVendir(nsName string, coreClient kubernetes.Interface,
	opts VendirOpts, cmdRunner exec.CmdRunner) *Vendir

NewVendir returns vendir.

func (*Vendir) AddDir

func (v *Vendir) AddDir(fetch v1alpha1.AppFetch, dirPath string) error

AddDir adds a directory to vendir's config for each fetcher that the app spec declares. vendir fetches resources into your filesystem, so the destination directory is a core part of vendir config.

func (*Vendir) ClearCache

func (v *Vendir) ClearCache(cacheID string) error

ClearCache removes all cache entries for the cacheID

func (*Vendir) Config

func (v *Vendir) Config() vendirconf.Config

Config is just for accessing (a copy of) the internal config for testing; you probably don't want to call this IRL

func (*Vendir) ConfigBytes

func (v *Vendir) ConfigBytes() ([]byte, error)

ConfigBytes fetches all the referenced Secrets & ConfigMaps and returns the multi-document YAML-encoded config that vendir consumes. https://github.com/vmware-tanzu/carvel-vendir/blob/develop/examples/secrets/vendir.yml

func (*Vendir) Run

func (v *Vendir) Run(conf []byte, workingDir string, cacheID string) exec.CmdRunResult

Run executes vendir command based on given configuration.

type VendirOpts

type VendirOpts struct {
	// ConfigHook provides an opportunity to make changes to vendir configuration
	// before it's given to vendir for execution. If not provided it will default
	// to the identity function.
	ConfigHook      func(vendirconf.Config) vendirconf.Config
	SkipTLSConfig   SkipTLSConfig
	BaseCacheFolder string
}

VendirOpts allows to customize vendir configuration given to vendir.