helm

Documentation

Index

• Constants
• Variables
• func DeployHelmChart(chartPath, releaseName, namespace string, opts ChartOptions) error
• func Init(...) error
• func Lint(out io.Writer, chartPath, namespace string, values, set, setString []string, ...) error
• func LintChartfileRules(linter *support.Linter)
• func PurgeHelmRelease(releaseName, namespace string, withNamespace, withHooks bool) error
• func ReleaseInstall(out io.Writer, chartPath, releaseName, namespace string, ...) error
• func ReleaseRollback(out io.Writer, releaseName string, revision int32, opts ReleaseRollbackOptions) error
• func ReleaseUpdate(out io.Writer, chartPath, releaseName string, values, set, setString []string, ...) error
• func Render(out io.Writer, chartPath, releaseName, namespace string, ...) error
• func WithExtra(extraAnnotations, extraLabels map[string]string, f func() error) error
• type ChartOptions
• type ChartTemplates
  • func GetTemplatesFromChart(chartPath, releaseName, namespace string, values, set, setString []string) (ChartTemplates, error)
  • func GetTemplatesFromRevision(releaseName string, revision int32) (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 ChartValuesOptions
• type LintOptions
• type ReleaseInstallOptions
• type ReleaseRollbackOptions
• type ReleaseState
• type ReleaseUpdateOptions
• type RenderOptions
• type ResourcesWaiter
  • func (waiter *ResourcesWaiter) WaitForResources(timeout time.Duration, created helmKube.Result) error
  • func (waiter *ResourcesWaiter) WatchUntilReady(namespace string, reader io.Reader, timeout time.Duration) error
• type Template
  • func (t Template) IsEmpty() bool
  • func (t Template) Namespace(namespace string) string
• type TrackAnno
• type WerfEngine
  • func NewWerfEngine() *WerfEngine
  • func (e *WerfEngine) Render(chrt *chart.Chart, values chartutil.Values) (map[string]string, error)

Constants

const (
	TrackAnnoName                    = "werf.io/track"
	FailModeAnnoName                 = "werf.io/fail-mode"
	AllowFailuresCountAnnoName       = "werf.io/allow-failures-count"
	LogWatchRegexAnnoName            = "werf.io/log-watch-regex"
	ContainerLogWatchRegexAnnoPrefix = "werf.io/log-watch-regex-for-"
	ShowLogsUntilAnnoName            = "werf.io/show-logs-until"
	SkipLogsForContainersAnnoName    = "werf.io/skip-logs-for-containers"
	ShowLogsOnlyForContainers        = "werf.io/show-logs-only-for-containers"

	TrackAnnoEnabledValue  TrackAnno = "true"
	TrackAnnoDisabledValue TrackAnno = "false"

	HelmHookAnnoName       = "helm.sh/hook"
	HelmHookWeightAnnoName = "helm.sh/hook-weight"
)

Variables

var (
	WerfTemplateEngine     = NewWerfEngine()
	WerfTemplateEngineName = "werfGoTpl"

	DefaultReleaseStorageNamespace = "kube-system"

	ConfigMapStorage = "configmap"
	SecretStorage    = "secret"

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

Functions

func DeployHelmChart

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

func Init

func Init(kubeConfig, kubeContext, helmReleaseStorageNamespace, helmReleaseStorageType string) error

func Lint

func Lint(out io.Writer, chartPath, namespace string, values, set, setString []string, opts LintOptions) error

func LintChartfileRules

func LintChartfileRules(linter *support.Linter)

func PurgeHelmRelease

func PurgeHelmRelease(releaseName, namespace string, withNamespace, withHooks bool) error

func ReleaseInstall

func ReleaseInstall(out io.Writer, chartPath, releaseName, namespace string, values, set, setString []string, opts ReleaseInstallOptions) error

func ReleaseRollback

func ReleaseRollback(out io.Writer, releaseName string, revision int32, opts ReleaseRollbackOptions) error

func ReleaseUpdate

func ReleaseUpdate(out io.Writer, chartPath, releaseName string, values, set, setString []string, opts ReleaseUpdateOptions) error

func Render

func Render(out io.Writer, chartPath, releaseName, namespace string, values, set, setString []string, opts RenderOptions) error

func WithExtra

func WithExtra(extraAnnotations, extraLabels map[string]string, f func() error) error

Types

type ChartOptions

type ChartOptions struct {
	Timeout time.Duration

	DryRun bool
	Debug  bool

	ChartValuesOptions
}

type ChartTemplates

type ChartTemplates []Template

func GetTemplatesFromChart

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

func GetTemplatesFromRevision

func GetTemplatesFromRevision(releaseName string, revision int32) (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 ChartValuesOptions

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

type LintOptions

type LintOptions struct {
	Strict bool
}

type ReleaseInstallOptions

type ReleaseInstallOptions struct {
	Debug bool
	// contains filtered or unexported fields
}

type ReleaseRollbackOptions

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

type ReleaseState

type ReleaseState struct {
	IsExists    bool
	StatusCode  string
	PurgeNeeded bool
}

type ReleaseUpdateOptions

type ReleaseUpdateOptions struct {
	Debug bool
	// contains filtered or unexported fields
}

type RenderOptions

type RenderOptions struct {
	ShowNotes bool
}

type ResourcesWaiter

type ResourcesWaiter struct {
	Client       *helmKube.Client
	LogsFromTime time.Time
}

func (*ResourcesWaiter) WaitForResources

func (waiter *ResourcesWaiter) WaitForResources(timeout time.Duration, created helmKube.Result) error

func (*ResourcesWaiter) WatchUntilReady

func (waiter *ResourcesWaiter) WatchUntilReady(namespace string, reader io.Reader, timeout time.Duration) error

type Template

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

func (Template) IsEmpty

func (t Template) IsEmpty() bool

func (Template) Namespace

func (t Template) Namespace(namespace string) string

type TrackAnno

type TrackAnno string

type WerfEngine

type WerfEngine struct {
	*engine.Engine

	ExtraAnnotations map[string]string
	ExtraLabels      map[string]string
}

func NewWerfEngine

func NewWerfEngine() *WerfEngine

func (*WerfEngine) Render

func (e *WerfEngine) Render(chrt *chart.Chart, values chartutil.Values) (map[string]string, error)