features

Documentation

Overview

Package features sets the feature gates that helm-controller supports, and their default states.

Index

• Constants
• func Disable(feature string)
• func Enabled(feature string) (bool, error)
• func FeatureGates() map[string]bool

Constants

const (
	// CacheSecretsAndConfigMaps configures the caching of Secrets and ConfigMaps
	// by the controller-runtime client.
	//
	// When enabled, it will cache both object types, resulting in increased memory
	// usage and cluster-wide RBAC permissions (list and watch).
	CacheSecretsAndConfigMaps = "CacheSecretsAndConfigMaps"

	// DetectDrift configures the detection of cluster state drift compared to
	// the desired state as described in the manifest of the Helm release
	// storage object.
	// Deprecated in v0.37.0, use the drift detection mode on the HelmRelease
	// object instead.
	DetectDrift = "DetectDrift"

	// CorrectDrift configures the correction of cluster state drift compared to
	// the desired state as described in the manifest of the Helm release. It
	// is only effective when DetectDrift is enabled.
	// Deprecated in v0.37.0, use the drift detection mode on the HelmRelease
	// object instead.
	CorrectDrift = "CorrectDrift"

	// AllowDNSLookups allows the controller to perform DNS lookups when rendering Helm
	// templates. This is disabled by default, as it can be a security risk.
	//
	// Ref: https://github.com/helm/helm/security/advisories/GHSA-pwcw-6f5g-gxf8
	AllowDNSLookups = "AllowDNSLookups"

	// OOMWatch enables the OOM watcher, which will gracefully shut down the controller
	// when the memory usage exceeds the configured limit. This is disabled by default.
	OOMWatch = "OOMWatch"

	// AdoptLegacyReleases enables the adoption of the historical Helm release
	// based on the status fields from a v2beta1 HelmRelease object.
	// This is enabled by default to support an upgrade path from v2beta1 to v2beta2
	// without the need to upgrade the Helm release. But it can be disabled to
	// avoid potential abuse of the adoption mechanism.
	AdoptLegacyReleases = "AdoptLegacyReleases"
)

Functions

func Disable

func Disable(feature string)

Disable disables the specified feature. If the feature is not present, it's a no-op.

func Enabled

func Enabled(feature string) (bool, error)

Enabled verifies whether the feature is enabled or not.

This is only a wrapper around the Enabled func in pkg/runtime/features, so callers won't need to import both packages for checking whether a feature is enabled.

func FeatureGates

func FeatureGates() map[string]bool

FeatureGates contains a list of all supported feature gates and their default values.