helm

Documentation

Index

• Variables
• func IsHelmOciChart(chart string) bool
• func IsMissingDependencyErr(err error) bool
• func IsVersion(text string) bool
• func Version(shortForm bool) (string, error)
• type Client
  • func NewClient(repoURL string, creds Creds, enableOci bool) Client
  • func NewClientWithLock(repoURL string, creds Creds, repoLock sync.KeyLock, enableOci bool) Client
• type Cmd
  • func NewCmd(workDir string, version string) (*Cmd, error)
  • func NewCmdWithVersion(workDir string, version HelmVer, isHelmOci bool) (*Cmd, error)
  • func (c *Cmd) ChartExport(repo string, chartName string, version string, destination string) (string, error)
  • func (c *Cmd) ChartPull(repo string, chart string, version string) (string, error)
  • func (c *Cmd) Close()
  • func (c *Cmd) Fetch(repo, chartName, version, destination string, creds Creds) (string, error)
  • func (c *Cmd) Init() (string, error)
  • func (c *Cmd) Login(repo string, creds Creds) (string, error)
  • func (c *Cmd) Logout(repo string, creds Creds) (string, error)
  • func (c *Cmd) RepoAdd(name string, url string, opts Creds) (string, error)
• type Creds
• type Entries
  • func (e Entries) MaxVersion(constraints *semver.Constraints) (*semver.Version, error)
• type Entry
• type Helm
  • func NewHelmApp(workDir string, repos []HelmRepository, isLocal bool, version string) (Helm, error)
• type HelmRepository
• type HelmVer
• type Index
  • func (i *Index) GetEntries(chart string) (Entries, error)
• type TemplateOpts

Variables

var (
	// HelmV2 represents helm V2 specific settings
	HelmV2 = HelmVer{
			// contains filtered or unexported fields
	}
	// HelmV3 represents helm V3 specific settings
	HelmV3 = HelmVer{
			// contains filtered or unexported fields
	}
)

Functions

func IsHelmOciChart

func IsHelmOciChart(chart string) bool

Only OCI registries support storing charts under sub-directories.

func IsMissingDependencyErr

func IsMissingDependencyErr(err error) bool

IsMissingDependencyErr tests if the error is related to a missing chart dependency

func IsVersion

func IsVersion(text string) bool

func Version

func Version(shortForm bool) (string, error)

Types

type Client

type Client interface {
	CleanChartCache(chart string, version *semver.Version) error
	ExtractChart(chart string, version *semver.Version) (string, io.Closer, error)
	GetIndex() (*Index, error)
	TestHelmOCI() (bool, error)
}

func NewClient

func NewClient(repoURL string, creds Creds, enableOci bool) Client

func NewClientWithLock

func NewClientWithLock(repoURL string, creds Creds, repoLock sync.KeyLock, enableOci bool) Client

type Cmd

type Cmd struct {
	HelmVer

	WorkDir   string
	IsLocal   bool
	IsHelmOci bool
	// contains filtered or unexported fields
}

A thin wrapper around the "helm" command, adding logging and error translation.

func NewCmd

func NewCmd(workDir string, version string) (*Cmd, error)

func NewCmdWithVersion

func NewCmdWithVersion(workDir string, version HelmVer, isHelmOci bool) (*Cmd, error)

func (*Cmd) ChartExport

func (c *Cmd) ChartExport(repo string, chartName string, version string, destination string) (string, error)

func (*Cmd) ChartPull

func (c *Cmd) ChartPull(repo string, chart string, version string) (string, error)

func (*Cmd) Close

func (c *Cmd) Close()

func (*Cmd) Fetch

func (c *Cmd) Fetch(repo, chartName, version, destination string, creds Creds) (string, error)

func (*Cmd) Init

func (c *Cmd) Init() (string, error)

func (*Cmd) Login

func (c *Cmd) Login(repo string, creds Creds) (string, error)

func (*Cmd) Logout

func (c *Cmd) Logout(repo string, creds Creds) (string, error)

func (*Cmd) RepoAdd

func (c *Cmd) RepoAdd(name string, url string, opts Creds) (string, error)

type Creds

type Creds struct {
	Username           string
	Password           string
	CAPath             string
	CertData           []byte
	KeyData            []byte
	InsecureSkipVerify bool
}

type Entries

type Entries []Entry

func (Entries) MaxVersion

func (e Entries) MaxVersion(constraints *semver.Constraints) (*semver.Version, error)

type Entry

type Entry struct {
	Version string
	Created time.Time
}

type Helm

type Helm interface {
	// Template returns a list of unstructured objects from a `helm template` command
	Template(opts *TemplateOpts) (string, error)
	// GetParameters returns a list of chart parameters taking into account values in provided YAML files.
	GetParameters(valuesFiles []string) (map[string]string, error)
	// DependencyBuild runs `helm dependency build` to download a chart's dependencies
	DependencyBuild() error
	// Init runs `helm init --client-only`
	Init() error
	// Dispose deletes temp resources
	Dispose()
}

Helm provides wrapper functionality around the `helm` command.

func NewHelmApp

func NewHelmApp(workDir string, repos []HelmRepository, isLocal bool, version string) (Helm, error)

NewHelmApp create a new wrapper to run commands on the `helm` command-line tool.

type HelmRepository

type HelmRepository struct {
	Creds
	Name string
	Repo string
}

type HelmVer

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

HelmVer contains Helm version specific settings such as helm binary and command names

type Index

type Index struct {
	Entries map[string]Entries
}

func (*Index) GetEntries

func (i *Index) GetEntries(chart string) (Entries, error)

type TemplateOpts

type TemplateOpts struct {
	Name        string
	Namespace   string
	KubeVersion string
	APIVersions []string
	Set         map[string]string
	SetString   map[string]string
	SetFile     map[string]string
	Values      []string
}