features

Documentation

Index

• Constants
• type FeatureGate
  • func NewFeatures(rawFeatures string) (FeatureGate, error)
  • func (f FeatureGate) Enabled(feature string) bool
  • func (f FeatureGate) Set(s string) error
  • func (f FeatureGate) String() string

Constants

const (
	// OIDCKubeCfgEndpoint if enabled exposes an HTTP endpoint for generating kubeconfig for a cluster that will contain OIDC tokens.
	OIDCKubeCfgEndpoint = "OIDCKubeCfgEndpoint"

	// PrometheusEndpoint if enabled exposes cluster's metrics HTTP endpoint.
	PrometheusEndpoint = "PrometheusEndpoint"

	// OpenIDAuthPlugin if enabled configures the flags on the API server to use
	// OAuth2 identity providers.
	OpenIDAuthPlugin = "OpenIDAuthPlugin"

	// VerticalPodAutoscaler if enabled the cluster-controller will enable the
	// VerticalPodAutoscaler for all control plane components.
	VerticalPodAutoscaler = "VerticalPodAutoscaler"

	// EtcdDataCorruptionChecks if enabled etcd will be started with
	// --experimental-initial-corrupt-check=true +
	// --experimental-corrupt-check-time=10m.
	EtcdDataCorruptionChecks = "EtcdDataCorruptionChecks"

	// EtcdLauncher if enabled will apply the cluster level etcd-launcher feature flag on all clusters,
	// unless it's explicitly disabled at the cluster level.
	EtcdLauncher = "EtcdLauncher"

	// UserClusterMLA if enabled MonitoringLoggingAlerting stack will be deployed with corresponding controller.
	UserClusterMLA = "UserClusterMLA"

	// HeadlessInstallation feature makes the KKP installer not install nginx and Dex. This is useful to create
	// a KKP system without UI/API deployments, that will only be interacted with using kubectl or similar means.
	// Setting this feature flag will make KKP ignore any UI/API/Ingress configuration.
	// This feature is in preview and not yet ready for production.
	HeadlessInstallation = "HeadlessInstallation"

	// DevelopmentEnvironment feature enables additional controllers only useful in shared development clusters.
	// Currently this includes the kkp-cluster-stuck-controller, but additional tweaks might be added to this feature
	// gate in the future.
	// This feature perpetually in preview and never ready for production.
	DevelopmentEnvironment = "DevelopmentEnvironment"
)

Types

type FeatureGate

type FeatureGate map[string]bool

FeatureGate is map of key=value pairs that enables/disables various features.

func NewFeatures

func NewFeatures(rawFeatures string) (FeatureGate, error)

NewFeatures takes comma separated key=value pairs for features and returns a FeatureGate.

func (FeatureGate) Enabled

func (f FeatureGate) Enabled(feature string) bool

Enabled returns true if the feature gate value of a particular feature is true.

func (FeatureGate) Set

func (f FeatureGate) Set(s string) error

func (FeatureGate) String

func (f FeatureGate) String() string