helm

Documentation

Index

• func GetAnnotationName() string
• func GetLabelName() string
• func Validate(param *HelmParam) []error
• type Chart
  • func (chart *Chart) FillDefaultValue(defaultChart *Chart)
• type Helm
  • func NewHelm(param *HelmParam, option ...Option) (*Helm, error)
  • func (h *Helm) AddOrUpdateChartRepo(entry repo.Entry) error
  • func (h *Helm) InstallOrUpgradeChart() error
  • func (h *Helm) UninstallHelmChartRelease() (err error)
• type HelmParam
• type Option
  • func WithChartSpec(spec *helmclient.ChartSpec) Option
  • func WithClient(client helmclient.Client) Option
  • func WithEntry(entry *repo.Entry) Option
• type Repo
  • func (repo *Repo) FillDefaultValue(defaultRepo *Repo)

Functions

func GetAnnotationName

func GetAnnotationName() string

GetAnnotationName will return label key for service created by helm

func GetLabelName

func GetLabelName() string

GetAnnotationName will return label key for service created by helm

func Validate

func Validate(param *HelmParam) []error

Validate validates helm param

Types

type Chart

type Chart struct {
	// if ChartPath equals to "", then Repo.Name and Repo.URL must be set
	ChartPath   string `mapstructure:"chartPath"`
	ChartName   string `mapstructure:"chartName"`
	Version     string `mapstructure:"version"`
	ReleaseName string `mapstructure:"releaseName"`
	Namespace   string `mapstructure:"namespace"`
	Wait        *bool  `mapstructure:"wait"`
	Timeout     string `mapstructure:"timeout"` // such as "1.5h" or "2h45m", valid time units are "s", "m", "h"
	UpgradeCRDs *bool  `mapstructure:"upgradeCRDs"`
	// ValuesYaml is the values.yaml content.
	// use string instead of map[string]interface{}
	ValuesYaml string `validate:"omitempty,yaml" mapstructure:"valuesYaml"`
}

Chart is the struct containing details of a helm chart. TODO(daniel-hutao): make the Chart equals to helmclient.ChartSpec

func (*Chart) FillDefaultValue

func (chart *Chart) FillDefaultValue(defaultChart *Chart)

type Helm

type Helm struct {
	*repo.Entry
	*helmclient.ChartSpec
	helmclient.Client
}

Helm is helm implementation

func NewHelm

func NewHelm(param *HelmParam, option ...Option) (*Helm, error)

NewHelm creates a new Helm

func (*Helm) AddOrUpdateChartRepo

func (h *Helm) AddOrUpdateChartRepo(entry repo.Entry) error

func (*Helm) InstallOrUpgradeChart

func (h *Helm) InstallOrUpgradeChart() error

func (*Helm) UninstallHelmChartRelease

func (h *Helm) UninstallHelmChartRelease() (err error)

type HelmParam

type HelmParam struct {
	Repo  Repo
	Chart Chart
}

HelmParam is the struct for parameters with helm style.

type Option

type Option func(*Helm)

func WithChartSpec

func WithChartSpec(spec *helmclient.ChartSpec) Option

func WithClient

func WithClient(client helmclient.Client) Option

func WithEntry

func WithEntry(entry *repo.Entry) Option

type Repo

type Repo struct {
	// if Name or URL equals to "", then Chart.ChartPath must be set
	Name string `mapstructure:"name"`
	URL  string `mapstructure:"url"`
}

Repo is the struct containing details of a git repository. TODO(daniel-hutao): make the Repo equals to repo.Entry

func (*Repo) FillDefaultValue

func (repo *Repo) FillDefaultValue(defaultRepo *Repo)