release

package
v0.19.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2020 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Overview

Package release provides interfaces and default implementations for a Helm release manager, which is used by the Helm controller and reconciler to manage Helm releases in a cluster based on watched custom resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type InstallOption added in v0.17.0

type InstallOption func(*action.Install) error

type Manager

type Manager interface {
	ReleaseName() string
	IsInstalled() bool
	IsUpdateRequired() bool
	Sync(context.Context) error
	InstallRelease(context.Context, ...InstallOption) (*rpb.Release, error)
	UpdateRelease(context.Context, ...UpdateOption) (*rpb.Release, *rpb.Release, error)
	ReconcileRelease(context.Context) (*rpb.Release, error)
	UninstallRelease(context.Context, ...UninstallOption) (*rpb.Release, error)
}

Manager manages a Helm release. It can install, update, reconcile, and uninstall a release.

type ManagerFactory

type ManagerFactory interface {
	NewManager(r *unstructured.Unstructured, overrideValues map[string]string) (Manager, error)
}

ManagerFactory creates Managers that are specific to custom resources. It is used by the HelmOperatorReconciler during resource reconciliation, and it improves decoupling between reconciliation logic and the Helm backend components used to manage releases.

func NewManagerFactory

func NewManagerFactory(mgr crmanager.Manager, chartDir string) ManagerFactory

NewManagerFactory returns a new Helm manager factory capable of installing and uninstalling releases.

type UninstallOption added in v0.17.0

type UninstallOption func(*action.Uninstall) error

type UpdateOption added in v0.17.0

type UpdateOption func(*action.Upgrade) error

func ForceUpdate added in v0.17.0

func ForceUpdate(force bool) UpdateOption

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL