helm

type ClientFactory ¶ added in v1.1.0

type ClientFactory struct {
	NewClientFn func(logger *log.Logger, labels map[string]string) client.HelmClient
	ClientType  ClientType
	// contains filtered or unexported fields
}

func InitHelmClientFactory(helmopts *Options, labels map[string]string) (*ClientFactory, error)

func (f *ClientFactory) NewClient(logger *log.Logger, options ...ClientOption) client.HelmClient

type ClientOption ¶ added in v1.6.2

type ClientOption func(client.HelmClient)

func WithExtraLabels(labels map[string]string) ClientOption

func WithLogLabels(logLabels map[string]string) ClientOption

type ClientType ¶ added in v1.1.0

type ClientType string

func DetectHelmVersion() (ClientType, error)

type FallbackClient ¶ added in v1.21.5

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

FallbackClient wraps a primary HelmClient (nelm) and falls back to a secondary HelmClient (helm3lib) when the primary returns one of the well-known nelm errors that helm3lib is able to recover from: action.ErrBuildPlan and resource.ErrResourceDuplicatesFound.

Read-only methods are always served by the primary client, both clients receive label/annotation updates so the fallback is ready to take over at any moment.

When MetricStorage is configured the client increments metrics.HelmFallbackTotal{module, operation, error_type} on every fallback.

func NewFallbackClient(primary, fallback client.HelmClient, logger *log.Logger, metricStorage MetricStorage) *FallbackClient

func (c *FallbackClient) DeleteRelease(releaseName string) error

func (c *FallbackClient) GetReleaseChecksum(releaseName string) (string, error)

func (c *FallbackClient) GetReleaseLabels(releaseName, labelName string) (string, error)

func (c *FallbackClient) GetReleaseValues(releaseName string) (utils.Values, error)

func (c *FallbackClient) IsReleaseExists(releaseName string) (bool, error)

func (c *FallbackClient) LastReleaseStatus(releaseName string) (string, string, error)

func (c *FallbackClient) ListReleasesNames() ([]string, error)

func (c *FallbackClient) Render(releaseName, chart string, valuesPaths, setValues []string, releaseLabels map[string]string, namespace string, debug bool) (string, error)

func (c *FallbackClient) UpgradeRelease(releaseName, chart string, valuesPaths, setValues []string, releaseLabels map[string]string, namespace string) error

func (c *FallbackClient) WithExtraLabels(labels map[string]string)

func (c *FallbackClient) WithLogLabels(logLabels map[string]string)

type MetricStorage ¶ added in v1.21.5

type MetricStorage interface {
	CounterAdd(metric string, value float64, labels map[string]string)
}

MetricStorage is the minimal counter-emitting surface FallbackClient needs. It is intentionally small so the helm package does not depend on the full metrics-storage interface.

type Options ¶ added in v1.6.0

type Options struct {
	Namespace         string
	HistoryMax        int32
	Timeout           time.Duration
	HelmIgnoreRelease string
	Logger            *log.Logger
	// MetricStorage is optional. When set, the fallback client emits a counter
	// every time it falls back from nelm to helm3lib.
	MetricStorage MetricStorage
}