helm

Documentation

Index

• Constants
• func NewManager(config *rest.Config, chartName string, repoURL *url.URL, releaseName string, ...) (install.Manager, error)
• func NewParser(base map[string]any, overrides map[string]string) install.ParameterParser
• type HomeDirFn
• type Installer
  • func (h *Installer) GetCurrentVersion() (string, error)
  • func (h *Installer) GetRelease() (*release.Release, error)
  • func (h *Installer) Install(version string, parameters map[string]any, opts ...install.InstallOption) error
  • func (h *Installer) Uninstall() error
  • func (h *Installer) Upgrade(version string, parameters map[string]any, opts ...install.UpgradeOption) error
• type InstallerModifierFn
  • func Force(f bool) InstallerModifierFn
  • func IsOCI() InstallerModifierFn
  • func RollbackOnError(r bool) InstallerModifierFn
  • func Wait() InstallerModifierFn
  • func WithAlternateChart(chartName string) InstallerModifierFn
  • func WithBasicAuth(username, password string) InstallerModifierFn
  • func WithCacheDir(c string) InstallerModifierFn
  • func WithChart(chartFile *os.File) InstallerModifierFn
  • func WithCreateNamespace(r bool) InstallerModifierFn
  • func WithLogger(l logging.Logger) InstallerModifierFn
  • func WithNamespace(ns string) InstallerModifierFn
  • func WithNoHooks() InstallerModifierFn
  • func WithReuseValues(r bool) InstallerModifierFn
  • func WithUpgradeInstall(r bool) InstallerModifierFn
• type LoaderFn
• type Parser
  • func (p *Parser) Parse() (map[string]any, error)
• type TempDirFn

Constants

const (
	// HelmChartConfigMediaType is the reserved media type for the Helm chart
	// manifest config.
	HelmChartConfigMediaType = "application/vnd.cncf.helm.config.v1+json"

	// HelmChartContentLayerMediaType is the reserved media type for Helm chart
	// package content.
	HelmChartContentLayerMediaType = "application/vnd.cncf.helm.chart.content.v1.tar+gzip"
)

Functions

func NewManager

func NewManager(config *rest.Config, chartName string, repoURL *url.URL, releaseName string, modifiers ...InstallerModifierFn) (install.Manager, error)

NewManager builds a helm install manager for UXP.

func NewParser

func NewParser(base map[string]any, overrides map[string]string) install.ParameterParser

NewParser returns a parameter parser backed by helm.

Types

type HomeDirFn

type HomeDirFn func() (string, error)

HomeDirFn indicates the location of a user's home directory.

type Installer

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

func (*Installer) GetCurrentVersion

func (h *Installer) GetCurrentVersion() (string, error)

GetCurrentVersion gets the current UXP version in the cluster.

func (*Installer) GetRelease

func (h *Installer) GetRelease() (*release.Release, error)

func (*Installer) Install

func (h *Installer) Install(version string, parameters map[string]any, opts ...install.InstallOption) error

Install installs in the cluster.

func (*Installer) Uninstall

func (h *Installer) Uninstall() error

Uninstall uninstalls an installation.

func (*Installer) Upgrade

func (h *Installer) Upgrade(version string, parameters map[string]any, opts ...install.UpgradeOption) error

Upgrade upgrades an existing installation to a new version.

type InstallerModifierFn

type InstallerModifierFn func(*Installer)

InstallerModifierFn modifies the installer.

func Force

func Force(f bool) InstallerModifierFn

Force will force operations when possible.

func IsOCI

func IsOCI() InstallerModifierFn

IsOCI indicates that the chart is an OCI image.

func RollbackOnError

func RollbackOnError(r bool) InstallerModifierFn

RollbackOnError will cause installer to rollback on failed upgrade.

func Wait

func Wait() InstallerModifierFn

Wait will wait operations till they are completed.

func WithAlternateChart

func WithAlternateChart(chartName string) InstallerModifierFn

WithAlternateChart sets an alternate chart that is compatible to upgrade from if installed.

func WithBasicAuth

func WithBasicAuth(username, password string) InstallerModifierFn

WithBasicAuth sets the username and password for the helm installer.

func WithCacheDir

func WithCacheDir(c string) InstallerModifierFn

WithCacheDir sets the cache directory for the helm installer.

func WithChart

func WithChart(chartFile *os.File) InstallerModifierFn

WithChart sets the chart to be installed/upgraded

func WithCreateNamespace

func WithCreateNamespace(r bool) InstallerModifierFn

func WithLogger

func WithLogger(l logging.Logger) InstallerModifierFn

WithLogger sets the logger for the helm installer.

func WithNamespace

func WithNamespace(ns string) InstallerModifierFn

WithNamespace sets the namespace for the helm installer.

func WithNoHooks

func WithNoHooks() InstallerModifierFn

WithNoHooks will disable uninstall hooks

func WithReuseValues

func WithReuseValues(r bool) InstallerModifierFn

WithLogger sets the logger for the helm installer.

func WithUpgradeInstall

func WithUpgradeInstall(r bool) InstallerModifierFn

type LoaderFn

type LoaderFn func(name string) (*chart.Chart, error)

LoaderFn knows how to load a helm chart.

type Parser

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

Parser is a helm-style parameter parser.

func (*Parser) Parse

func (p *Parser) Parse() (map[string]any, error)

Parse parses install and upgrade parameters

type TempDirFn

type TempDirFn func(afero.Fs, string, string) (string, error)

TempDirFn knows how to create a temporary directory in a filesystem.