helm

Documentation

Index

• Constants
• func LoadFS(fsys fs.FS) (*chart.Chart, error)
• func LoadPath(path string) (*chart.Chart, error)
• func LoadPathOrEmbedded(path string) (*chart.Chart, error)
• type Config
• type ConfigOptFn
  • func WithDefaultKubeConfigPath(path string) ConfigOptFn
  • func WithDefaultNamespace(ns string) ConfigOptFn
  • func WithDefaultReleaseName(release string) ConfigOptFn
  • func WithValuesOpts(opts []ValuesOpts) ConfigOptFn
• type ContainerImages
• type Installer
  • func New(config *Config, opts ...ConfigOptFn) (*Installer, error)
  • func (i *Installer) Deployments() []string
  • func (i *Installer) Install(ctx context.Context) error
  • func (i *Installer) Uninstall(ctx context.Context) error
• type Values
  • func NewEmptyValues() Values
• type ValuesOpts
  • func WithContainerImages(images *ContainerImages) ValuesOpts
  • func WithGatewayNodePort(port int) ValuesOpts
  • func WithKubernetesProvider() ValuesOpts
  • func WithValues(v Values) ValuesOpts
  • func WithValuesFile(path string) ValuesOpts

Constants

const (
	// https://helm.sh/docs/topics/advanced/#storage-backends
	DefaultHelmDriver    = "secret"
	DefaultHelmNamespace = "default"
)

const (
	DefaultInstallTimeout   = 15 * time.Minute
	DefaultUninstallTimeout = 5 * time.Minute
)

Functions

func LoadFS

func LoadFS(fsys fs.FS) (*chart.Chart, error)

func LoadPath

func LoadPath(path string) (*chart.Chart, error)

func LoadPathOrEmbedded

func LoadPathOrEmbedded(path string) (*chart.Chart, error)

Types

type Config

type Config struct {
	Namespace      string `mapstructure:"namespace"`
	ReleaseName    string `mapstructure:"release_name"`
	ChartPath      string `mapstructure:"chart_path"`
	StorageDriver  string `mapstructure:"driver"`
	KubeConfigPath string `mapstructure:"kubeconfig"`
	// contains filtered or unexported fields
}

type ConfigOptFn

type ConfigOptFn func(*Config) error

ConfigOptFn defines transformer function for Config.

func WithDefaultKubeConfigPath

func WithDefaultKubeConfigPath(path string) ConfigOptFn

func WithDefaultNamespace

func WithDefaultNamespace(ns string) ConfigOptFn

func WithDefaultReleaseName

func WithDefaultReleaseName(release string) ConfigOptFn

func WithValuesOpts

func WithValuesOpts(opts []ValuesOpts) ConfigOptFn

type ContainerImages

type ContainerImages = envtypes.ContainerImages[envtypes.ImageRef]

type Installer

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

func New

func New(config *Config, opts ...ConfigOptFn) (*Installer, error)

func (*Installer) Deployments

func (i *Installer) Deployments() []string

func (*Installer) Install

func (i *Installer) Install(ctx context.Context) error

func (*Installer) Uninstall

func (i *Installer) Uninstall(ctx context.Context) error

type Values

type Values = chartutil.Values

func NewEmptyValues

func NewEmptyValues() Values

type ValuesOpts

type ValuesOpts func(values *Values) error

func WithContainerImages

func WithContainerImages(images *ContainerImages) ValuesOpts

func WithGatewayNodePort

func WithGatewayNodePort(port int) ValuesOpts

func WithKubernetesProvider

func WithKubernetesProvider() ValuesOpts

func WithValues

func WithValues(v Values) ValuesOpts

func WithValuesFile

func WithValuesFile(path string) ValuesOpts