helmexec

Documentation

Index

• func GetHelmVersion(helmBinary string, runner Runner) (semver.Version, error)
• func GetPluginVersion(name, pluginsDir string) (*semver.Version, error)
• func Indent(text, indent string) string
• func LiveOutput(c *exec.Cmd, stdout io.Writer) ([]byte, error)
• func New(helmBinary string, enableLiveOutput bool, logger *zap.SugaredLogger, ...) *execer
• func NewLogger(writer io.Writer, logLevel string) *zap.SugaredLogger
• func Output(c *exec.Cmd, logWriterGenerators ...*logWriterGenerator) ([]byte, error)
• type DependencyUpdater
• type ExitError
  • func (e ExitError) Error() string
  • func (e ExitError) ExitStatus() int
• type HelmContext
  • func (context *HelmContext) GetTillerlessArgs(helm *execer) []string
• type Interface
• type Runner
• type ShellRunner
  • func (shell ShellRunner) Execute(cmd string, args []string, env map[string]string, enableLiveOutput bool) ([]byte, error)
  • func (shell ShellRunner) ExecuteStdIn(cmd string, args []string, env map[string]string, stdin io.Reader) ([]byte, error)
• type Version

Functions

func GetHelmVersion

func GetHelmVersion(helmBinary string, runner Runner) (semver.Version, error)

func GetPluginVersion

func GetPluginVersion(name, pluginsDir string) (*semver.Version, error)

func Indent

func Indent(text, indent string) string

indents a block of text with an indent string

func LiveOutput

func LiveOutput(c *exec.Cmd, stdout io.Writer) ([]byte, error)

func New

func New(helmBinary string, enableLiveOutput bool, logger *zap.SugaredLogger, kubeContext string, runner Runner) *execer

New for running helm commands nolint: golint

func NewLogger

func NewLogger(writer io.Writer, logLevel string) *zap.SugaredLogger

func Output

func Output(c *exec.Cmd, logWriterGenerators ...*logWriterGenerator) ([]byte, error)

Types

type DependencyUpdater

type DependencyUpdater interface {
	UpdateDeps(chart string) error
	IsHelm3() bool
}

type ExitError

type ExitError struct {
	Message string
	Code    int
}

ExitError is created whenever your shell command exits with a non-zero exit status

func (ExitError) Error

func (e ExitError) Error() string

func (ExitError) ExitStatus

func (e ExitError) ExitStatus() int

type HelmContext

type HelmContext struct {
	Tillerless      bool
	TillerNamespace string
	HistoryMax      int
	WorkerIndex     int
	Writer          io.Writer
}

func (*HelmContext) GetTillerlessArgs

func (context *HelmContext) GetTillerlessArgs(helm *execer) []string

type Interface

type Interface interface {
	SetExtraArgs(args ...string)
	SetHelmBinary(bin string)
	SetEnableLiveOutput(enableLiveOutput bool)

	AddRepo(name, repository, cafile, certfile, keyfile, username, password string, managed string, passCredentials string, skipTLSVerify string) error
	UpdateRepo() error
	RegistryLogin(name string, username string, password string) error
	BuildDeps(name, chart string) error
	UpdateDeps(chart string) error
	SyncRelease(context HelmContext, name, chart string, flags ...string) error
	DiffRelease(context HelmContext, name, chart string, suppressDiff bool, flags ...string) error
	TemplateRelease(name, chart string, flags ...string) error
	Fetch(chart string, flags ...string) error
	ChartPull(chart string, path string, flags ...string) error
	ChartExport(chart string, path string, flags ...string) error
	Lint(name, chart string, flags ...string) error
	ReleaseStatus(context HelmContext, name string, flags ...string) error
	DeleteRelease(context HelmContext, name string, flags ...string) error
	TestRelease(context HelmContext, name string, flags ...string) error
	List(context HelmContext, filter string, flags ...string) (string, error)
	DecryptSecret(context HelmContext, name string, flags ...string) (string, error)
	IsHelm3() bool
	GetVersion() Version
	IsVersionAtLeast(versionStr string) bool
	ShowChart(chart string) (chart.Metadata, error)
}

Interface for executing helm commands

type Runner

type Runner interface {
	Execute(cmd string, args []string, env map[string]string, enableLiveOutput bool) ([]byte, error)
	ExecuteStdIn(cmd string, args []string, env map[string]string, stdin io.Reader) ([]byte, error)
}

Runner interface for shell commands

type ShellRunner

type ShellRunner struct {
	Dir string

	Logger *zap.SugaredLogger
}

ShellRunner implemention for shell commands

func (ShellRunner) Execute

func (shell ShellRunner) Execute(cmd string, args []string, env map[string]string, enableLiveOutput bool) ([]byte, error)

Execute a shell command

func (ShellRunner) ExecuteStdIn

func (shell ShellRunner) ExecuteStdIn(cmd string, args []string, env map[string]string, stdin io.Reader) ([]byte, error)

Execute a shell command

type Version

type Version struct {
	Major int
	Minor int
	Patch int
}

Version represents the version of helm