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(ctx context.Context, c *exec.Cmd, stripArgsValuesOnExitError bool, ...) ([]byte, error)
• func New(helmBinary string, options HelmExecOptions, logger *zap.SugaredLogger, ...) (*execer, error)
• func NewLogger(writer io.Writer, logLevel string) *zap.SugaredLogger
• func Output(ctx context.Context, c *exec.Cmd, stripArgsValuesOnExitError bool, ...) ([]byte, error)
• type DependencyUpdater
• type ExitError
  • func (e ExitError) Error() string
  • func (e ExitError) ExitStatus() int
• type HelmContext
• type HelmExecOptions
• type Interface
• type PluginMetadata
• 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(ctx context.Context, c *exec.Cmd, stripArgsValuesOnExitError bool, stdout io.Writer) ([]byte, error)

func New

func New(helmBinary string, options HelmExecOptions, logger *zap.SugaredLogger, kubeconfig string, kubeContext string, runner Runner) (*execer, error)

New for running helm commands

func NewLogger

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

func Output

func Output(ctx context.Context, c *exec.Cmd, stripArgsValuesOnExitError bool, logWriterGenerators ...*logWriterGenerator) ([]byte, error)

Types

type DependencyUpdater

type DependencyUpdater interface {
	UpdateDeps(chart string) error
	IsHelm3() bool
	IsHelm4() 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 {
	HistoryMax  int
	WorkerIndex int
	Writer      io.Writer
}

type HelmExecOptions

type HelmExecOptions struct {
	EnableLiveOutput          bool
	DisableForceUpdate        bool // If true, do not force helm repos to update when executing "helm repo add" (Helm 3)
	EnforcePluginVerification bool // If true, fail plugin installation if verification is not supported
	HelmOCIPlainHTTP          bool // If true, use plain HTTP for OCI registries
}

type Interface

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

	AddRepo(name, repository, cafile, certfile, keyfile, username, password string, managed string, passCredentials, skipTLSVerify bool) error
	UpdateRepo() error
	RegistryLogin(name, username, password, caFile, certFile, keyFile string, skipTLSVerify bool) error
	BuildDeps(name, chart string, flags ...string) error
	UpdateDeps(chart string) error
	SyncRelease(context HelmContext, name, chart, namespace string, flags ...string) error
	DiffRelease(context HelmContext, name, chart, namespace 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) error
	Lint(name, chart string, flags ...string) error
	Unittest(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
	IsHelm4() bool
	GetVersion() Version
	IsVersionAtLeast(versionStr string) bool
	ShowChart(chart string) (chart.Metadata, error)
}

Interface for executing helm commands

type PluginMetadata

type PluginMetadata struct {
	Name    string `yaml:"name"`
	Version string `yaml:"version"`
}

PluginMetadata represents the metadata of a Helm plugin

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

	StripArgsValuesOnExitError bool

	Logger *zap.SugaredLogger
	Ctx    context.Context
}

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