features

Documentation

Overview

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

Index

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

Constants

const (
	// GitForcePushBranch enables the use of "force push" when push branches
	// are configured.
	GitForcePushBranch = "GitForcePushBranch"
	// GitShallowClone enables the use of shallow clones when pulling source from
	// Git repositories.
	GitShallowClone = "GitShallowClone"
	// GitAllBranchReferences enables the download of all branch head references
	// when push branches are configured. When enabled fixes fluxcd/flux2#3384.
	GitAllBranchReferences = "GitAllBranchReferences"
	// CacheSecretsAndConfigMaps controls whether Secrets and ConfigMaps should
	// be cached.
	//
	// When enabled, it will cache both object types, resulting in increased
	// memory usage and cluster-wide RBAC permissions (list and watch).
	CacheSecretsAndConfigMaps = "CacheSecretsAndConfigMaps"
)

Functions

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.