helm

Documentation

Overview

Package helm handle helm resources

Index

• type Helm
  • func NewHelm(settings helm_env.EnvSettings, out io.Writer) *Helm
  • func (h *Helm) LoadChart(c *LoadChartConfig) (*chart.Chart, error)
  • func (h *Helm) LocateChartPath(repoURL, username, password, name, version string, verify bool, ...) (string, error)
  • func (h *Helm) RenderChart(c *RenderChartConfig) ([]manifest.Manifest, error)
  • func (h *Helm) Vals(valueFiles ValueFiles, values []string, stringValues []string, ...) ([]byte, error)
• type LoadChartConfig
• type RenderChartConfig
• type ValueFiles
  • func (v *ValueFiles) Set(value string) error
  • func (v *ValueFiles) String() string
  • func (v *ValueFiles) Type() string

Types

type Helm

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

Helm type

func NewHelm

func NewHelm(settings helm_env.EnvSettings, out io.Writer) *Helm

NewHelm constructs helm

func (*Helm) LoadChart

func (h *Helm) LoadChart(c *LoadChartConfig) (*chart.Chart, error)

LoadChart download a chart or load it from cache

func (*Helm) LocateChartPath

func (h *Helm) LocateChartPath(repoURL, username, password, name, version string, verify bool, keyring,
	certFile, keyFile, caFile string) (string, error)

LocateChartPath looks for a chart directory in known places, and returns either the full path or an error.

This does not ensure that the chart is well-formed; only that the requested filename exists.

Order of resolution: - current working directory - if path is absolute or begins with '.', error out here - chart repos in $HELM_HOME - URL

If 'verify' is true, this will attempt to also verify the chart.

func (*Helm) RenderChart

func (h *Helm) RenderChart(c *RenderChartConfig) ([]manifest.Manifest, error)

RenderChart manifest

func (*Helm) Vals

func (h *Helm) Vals(valueFiles ValueFiles, values []string, stringValues []string, fileValues []string, CertFile, KeyFile, CAFile string) ([]byte, error)

Vals merges values from files specified via -f/--values and directly via --set or --set-string or --set-file, marshaling them to YAML

type LoadChartConfig

type LoadChartConfig struct {
	RepoURL  string
	Username string
	Password string
	Chart    string
	Version  string
	DepUp    bool
	Verify   bool
	Keyring  string
	CertFile string
	KeyFile  string
	CaFile   string
}

LoadChartConfig define the configuration to load a chart

type RenderChartConfig

type RenderChartConfig struct {
	ChartRequested *chart.Chart
	Name           string
	Namespace      string
	ValueFiles     ValueFiles
	Values         []string
	StringValues   []string
	FileValues     []string
}

RenderChartConfig define the configuration to render a chart

type ValueFiles

type ValueFiles []string

ValueFiles type

func (*ValueFiles) Set

func (v *ValueFiles) Set(value string) error

Set split coma separated values into a set of values

func (*ValueFiles) String

func (v *ValueFiles) String() string

String convert a pointer into a string

func (*ValueFiles) Type

func (v *ValueFiles) Type() string

Type return the string ValueFiles