helm

Documentation

Index

• func GetAnnotationName() string
• func GetLabelName() string
• func Validate(param *HelmParam) []error
• type Chart
  • func (chart *Chart) FillDefaultValue(defaultChart *Chart)
• type Daemonset
• type Deployment
• 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 InstanceState
  • func (is *InstanceState) ToStringInterfaceMap() map[string]interface{}
• 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)
• type Statefulset
• type Workflows
  • func (w *Workflows) AddDaemonset(name string, ready bool)
  • func (w *Workflows) AddDeployment(name string, ready bool)
  • func (w *Workflows) AddStatefulset(name string, ready bool)

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

Types

type Chart

type Chart struct {
	ChartName       string `validate:"required" mapstructure:"chart_name"`
	Version         string `mapstructure:"version"`
	ReleaseName     string `mapstructure:"release_name"`
	Namespace       string `mapstructure:"namespace"`
	CreateNamespace *bool  `mapstructure:"create_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 `mapstructure:"values_yaml"`
}

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 Daemonset

type Daemonset struct {
	Name  string `yaml:"name"`
	Ready bool   `yaml:"ready"`
}

type Deployment

type Deployment struct {
	Name  string `yaml:"name"`
	Ready bool   `yaml:"ready"`
}

type Helm

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

func NewHelm

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

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 InstanceState

type InstanceState struct {
	Workflows Workflows
}

func (*InstanceState) ToStringInterfaceMap

func (is *InstanceState) ToStringInterfaceMap() map[string]interface{}

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 {
	Name string `validate:"required" mapstructure:"name"`
	URL  string `validate:"required" 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)

type Statefulset

type Statefulset struct {
	Name  string `yaml:"name"`
	Ready bool   `yaml:"ready"`
}

type Workflows

type Workflows struct {
	Deployments  []Deployment  `yaml:"deployments,omitempty"`
	Daemonsets   []Daemonset   `yaml:"daemonsets,omitempty"`
	Statefulsets []Statefulset `yaml:"statefulsets,omitempty"`
}

func (*Workflows) AddDaemonset

func (w *Workflows) AddDaemonset(name string, ready bool)

func (*Workflows) AddDeployment

func (w *Workflows) AddDeployment(name string, ready bool)

func (*Workflows) AddStatefulset

func (w *Workflows) AddStatefulset(name string, ready bool)