helm

Documentation

Overview

Package helm is for our default helm command object and operations

Index

• type ChartRepoEntryVersion
• type ChartRepoIndexYAML
• type Helm
  • func (h *Helm) Exec(subCommand string) (string, error)
  • func (h *Helm) GetAvailableChartVersions(chartName string) ([]*interfaces.HelmAvailableChartVersion, error)
  • func (h *Helm) GetExecConfig() *interfaces.HelmExecConfig
  • func (h *Helm) GetReleaseStatus(chartName string, chartNamespace string) (*interfaces.HelmReleaseStatus, error)
  • func (h *Helm) Initialize(execConfig *interfaces.HelmExecConfig, ...) error

Types

type ChartRepoEntryVersion

type ChartRepoEntryVersion struct {
	URLs    []string `yaml:"urls"`
	Version string   `yaml:"version"`
}

ChartRepoEntryVersion is a single version for a chart in a chart repo index.yaml

type ChartRepoIndexYAML

type ChartRepoIndexYAML struct {
	Entries map[string][]*ChartRepoEntryVersion `yaml:"entries"`
}

ChartRepoIndexYAML is the root index of a chart repo

type Helm

type Helm struct {
	ExecConfig   *interfaces.HelmExecConfig
	ChartsSource *interfaces.HelmChartsSource
}

Helm is our object for running helm command and operations, implements internal/interfaces/helm.go

func (*Helm) Exec

func (h *Helm) Exec(subCommand string) (string, error)

Exec will run a helm cli command/sub-command

func (*Helm) GetAvailableChartVersions

func (h *Helm) GetAvailableChartVersions(chartName string) ([]*interfaces.HelmAvailableChartVersion, error)

GetAvailableChartVersions will return a list of available versions for a given chart according to our charts source

func (*Helm) GetExecConfig

func (h *Helm) GetExecConfig() *interfaces.HelmExecConfig

GetExecConfig returns the existing ExecConfig

func (*Helm) GetReleaseStatus

func (h *Helm) GetReleaseStatus(chartName string, chartNamespace string) (*interfaces.HelmReleaseStatus, error)

GetReleaseStatus attempts to retrieve the status of a chart release

func (*Helm) Initialize

func (h *Helm) Initialize(execConfig *interfaces.HelmExecConfig, chartsSource *interfaces.HelmChartsSource) error

Initialize will set our instance up with necessary config/settings and run some initial validation as well