helm

Documentation

Index

• Constants
• Variables
• func DeployHelmChart(chartPath, releaseName, namespace string, opts HelmChartOptions) error
• func FormatHelmCmdError(stdout, stderr string, err error) error
• func FormatHelmCmdOutput(stdout, stderr string) string
• func HelmCmd(args ...string) (stdout string, stderr string, err error)
• func HelmVersion() (*version.Version, error)
• func PurgeHelmRelease(releaseName string) error
• func ValidateHelmVersion() error
• type ChartTemplates
  • func GetTemplatesFromChart(chartPath, releaseName string, set, setString, values []string) (ChartTemplates, error)
  • func GetTemplatesFromRevision(releaseName string, revision int) (ChartTemplates, error)
  • func (templates ChartTemplates) ByKind(kind string) []Template
  • func (templates ChartTemplates) DaemonSets() []Template
  • func (templates ChartTemplates) Deployments() []Template
  • func (templates ChartTemplates) Jobs() []Template
  • func (templates ChartTemplates) Pods() []Template
  • func (templates ChartTemplates) StatefulSets() []Template
• type HelmChartOptions
• type HelmChartValuesOptions
• type ReleaseHistory
  • func GetReleaseHistory(releaseName string) (ReleaseHistory, error)
• type ReleaseHistoryRecord
• type ReleaseStatus
• type Template
  • func (t Template) Namespace(namespace string) string
• type TrackAnno

Constants

const (
	DefaultHelmTimeout = 24 * time.Hour

	TrackAnnoName          = "werf.io/track"
	HelmHookAnnoName       = "helm.sh/hook"
	HelmHookWeightAnnoName = "helm.sh/hook-weight"

	TrackDisabled  TrackAnno = "false"
	TrackTillDone  TrackAnno = "till_done"
	TrackTillReady TrackAnno = "till_ready"
)

Variables

var (
	ErrNoDeployedReleaseRevisionFound = errors.New("no DEPLOYED release revision found")
)

var (
	KubeContext string
)

Functions

func DeployHelmChart

func DeployHelmChart(chartPath, releaseName, namespace string, opts HelmChartOptions) error

func FormatHelmCmdError

func FormatHelmCmdError(stdout, stderr string, err error) error

func FormatHelmCmdOutput

func FormatHelmCmdOutput(stdout, stderr string) string

func HelmCmd

func HelmCmd(args ...string) (stdout string, stderr string, err error)

func HelmVersion

func HelmVersion() (*version.Version, error)

func PurgeHelmRelease

func PurgeHelmRelease(releaseName string) error

func ValidateHelmVersion

func ValidateHelmVersion() error

Types

type ChartTemplates

type ChartTemplates []Template

func GetTemplatesFromChart

func GetTemplatesFromChart(chartPath, releaseName string, set, setString, values []string) (ChartTemplates, error)

func GetTemplatesFromRevision

func GetTemplatesFromRevision(releaseName string, revision int) (ChartTemplates, error)

func (ChartTemplates) ByKind

func (templates ChartTemplates) ByKind(kind string) []Template

func (ChartTemplates) DaemonSets

func (templates ChartTemplates) DaemonSets() []Template

func (ChartTemplates) Deployments

func (templates ChartTemplates) Deployments() []Template

func (ChartTemplates) Jobs

func (templates ChartTemplates) Jobs() []Template

func (ChartTemplates) Pods

func (templates ChartTemplates) Pods() []Template

func (ChartTemplates) StatefulSets

func (templates ChartTemplates) StatefulSets() []Template

type HelmChartOptions

type HelmChartOptions struct {
	Timeout time.Duration

	DryRun bool
	Debug  bool

	HelmChartValuesOptions
}

type HelmChartValuesOptions

type HelmChartValuesOptions struct {
	Set       []string
	SetString []string
	Values    []string
}

type ReleaseHistory

type ReleaseHistory []ReleaseHistoryRecord

func GetReleaseHistory

func GetReleaseHistory(releaseName string) (ReleaseHistory, error)

type ReleaseHistoryRecord

type ReleaseHistoryRecord struct {
	Revision    int    `json:"revision"`
	Updated     string `json:"updated"`
	Status      string `json:"status"`
	Chart       string `json:"chart"`
	Description string `json:"description"`
}

type ReleaseStatus

type ReleaseStatus struct {
	IsExists    bool
	Status      string
	PurgeNeeded bool
}

type Template

type Template struct {
	Version  string `yaml:"apiVersion"`
	Kind     string `yaml:"kind,omitempty"`
	Metadata struct {
		Name        string            `yaml:"name"`
		Namespace   string            `yaml:"namespace"`
		Annotations map[string]string `yaml:"annotations"`
		UID         string            `yaml:"uid"`
	} `yaml:"metadata,omitempty"`
	Status string `yaml:"status,omitempty"`
}

func (Template) Namespace

func (t Template) Namespace(namespace string) string

type TrackAnno

type TrackAnno string