release

Documentation

Index

• Constants
• func ObserveRelease(start time.Time, success bool, namespace, releaseName string)
• func ObserveReleaseAction(start time.Time, action action, success bool, namespace, releaseName string)
• type Config
  • func (c Config) WithDefaults() Config
• type Release
  • func New(logger log.Logger, helmClients *helm.Clients, ...) *Release
  • func (r *Release) Sync(hr *apiV1.HelmRelease) (err error)
  • func (r *Release) Uninstall(hr *apiV1.HelmRelease) error

Constants

const (
	AppIdLabelKey       = "o.app.id"
	ComponentIdLabelKey = "oam.runtime.component.id"
	IstioEnableLabelKey = "istio-injection"
)

const (
	LabelSuccess         = "success"
	LabelNamespace       = "namespace"
	LabelTargetNamespace = "target_namespace"
	LabelReleaseName     = "release_name"
	LabelAction          = "action"
)

const (
	InstallAction       action = "install"
	UpgradeAction       action = "upgrade"
	MigrateAction       action = "migrate"
	SkipAction          action = "skip"
	RollbackAction      action = "rollback"
	UninstallAction     action = "uninstall"
	DryRunCompareAction action = "dry-run-compare"
	AnnotateAction      action = "annotate"
	TestAction          action = "test"
)

const (
	MigrateAnnotation string = "helm.fluxcd.io/migrate"
)

Functions

func ObserveRelease

func ObserveRelease(start time.Time, success bool, namespace, releaseName string)

func ObserveReleaseAction

func ObserveReleaseAction(start time.Time, action action, success bool, namespace, releaseName string)

Types

type Config

type Config struct {
	ChartCache         string
	UpdateDeps         bool
	LogDiffs           bool
	DefaultHelmVersion string
}

Config holds the configuration for releases.

func (Config) WithDefaults

func (c Config) WithDefaults() Config

WithDefaults sets the default values for the release config.

type Release

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

Release holds the elements required to perform a Helm release, and provides the methods to perform a sync or uninstall.

func New

func New(logger log.Logger, helmClients *helm.Clients, coreV1Client corev1client.CoreV1Interface, hrClient v1client.HelmV1Interface,
	gitChartSync *chartsync.GitChartSync, config Config, converter helmV3.Converter) *Release

New returns a new instance of Release

func (*Release) Sync

func (r *Release) Sync(hr *apiV1.HelmRelease) (err error)

Sync synchronizes the given HelmRelease with Helm.

func (*Release) Uninstall

func (r *Release) Uninstall(hr *apiV1.HelmRelease) error

Uninstalls removes the Helm release for the given HelmRelease, and the git chart source if present.