helm3

Documentation

Index

• Variables
• func Init(options *Helm3Options) error
• func NewClient(logLabels ...map[string]string) client.HelmClient
• type Helm3Client
  • func (h *Helm3Client) CommandEnv() []string
  • func (h *Helm3Client) DeleteOldFailedRevisions(releaseName string) error
  • func (h *Helm3Client) DeleteRelease(releaseName string) (err error)
  • func (h *Helm3Client) DeleteSingleFailedRevision(releaseName string) error
  • func (h *Helm3Client) GetReleaseValues(releaseName string) (utils.Values, error)
  • func (h *Helm3Client) IsReleaseExists(releaseName string) (bool, error)
  • func (h *Helm3Client) LastReleaseStatus(releaseName string) (revision string, status string, err error)
  • func (h *Helm3Client) ListReleases(labelSelector map[string]string) (releases []string, err error)
  • func (h *Helm3Client) ListReleasesNames(labelSelector map[string]string) ([]string, error)
  • func (h *Helm3Client) Render(releaseName string, chart string, valuesPaths []string, setValues []string, ...) (string, error)
  • func (h *Helm3Client) UpgradeRelease(releaseName string, chart string, valuesPaths []string, setValues []string, ...) error
  • func (h *Helm3Client) WithKubeClient(client klient.Client)
• type Helm3Options

Variables

var Helm3Path = "helm"

Functions

func Init

func Init(options *Helm3Options) error

Init runs

func NewClient

func NewClient(logLabels ...map[string]string) client.HelmClient

Types

type Helm3Client

type Helm3Client struct {
	KubeClient klient.Client
	LogEntry   *log.Entry
	Namespace  string
}

func (*Helm3Client) CommandEnv

func (h *Helm3Client) CommandEnv() []string

func (*Helm3Client) DeleteOldFailedRevisions

func (h *Helm3Client) DeleteOldFailedRevisions(releaseName string) error

func (*Helm3Client) DeleteRelease

func (h *Helm3Client) DeleteRelease(releaseName string) (err error)

func (*Helm3Client) DeleteSingleFailedRevision

func (h *Helm3Client) DeleteSingleFailedRevision(releaseName string) error

func (*Helm3Client) GetReleaseValues

func (h *Helm3Client) GetReleaseValues(releaseName string) (utils.Values, error)

func (*Helm3Client) IsReleaseExists

func (h *Helm3Client) IsReleaseExists(releaseName string) (bool, error)

func (*Helm3Client) LastReleaseStatus

func (h *Helm3Client) LastReleaseStatus(releaseName string) (revision string, status string, err error)

LastReleaseStatus returns last known revision for release and its status

Example helm history output:
REVISION	UPDATED                 	STATUS    	CHART                 	DESCRIPTION
1        Fri Jul 14 18:25:00 2017	SUPERSEDED	symfony-demo-0.1.0    	Install complete

func (*Helm3Client) ListReleases

func (h *Helm3Client) ListReleases(labelSelector map[string]string) (releases []string, err error)

ListReleases returns all known releases as strings — "<release_name>.v<release_number>" It is required only for helm2.

func (*Helm3Client) ListReleasesNames

func (h *Helm3Client) ListReleasesNames(labelSelector map[string]string) ([]string, error)

ListReleasesNames returns list of release names. Names are extracted from label "name" in Secrets with label "owner"=="helm".

func (*Helm3Client) Render

func (h *Helm3Client) Render(releaseName string, chart string, valuesPaths []string, setValues []string, namespace string) (string, error)

Render renders helm templates for chart

func (*Helm3Client) UpgradeRelease

func (h *Helm3Client) UpgradeRelease(releaseName string, chart string, valuesPaths []string, setValues []string, namespace string) error

func (*Helm3Client) WithKubeClient

func (h *Helm3Client) WithKubeClient(client klient.Client)

type Helm3Options

type Helm3Options struct {
	Namespace  string
	HistoryMax int32
	Timeout    time.Duration
	KubeClient klient.Client
}

var Options *Helm3Options