featuregates

Documentation

Index

• Constants
• type FeatureGates
  • func GetFeatureGatesDefaults() FeatureGates
  • func New(setupLog logr.Logger, featureGates map[string]bool) (FeatureGates, error)
  • func (fg FeatureGates) Enabled(feature string) bool

Constants

const (
	// GatewayAlphaFeature is the name of the feature-gate for enabling or
	// disabling the Alpha maturity APIs and relevant features for Gateway API.
	GatewayAlphaFeature = "GatewayAlpha"

	// FillIDsFeature is the name of the feature-gate that makes KIC fill in the ID fields of Kong entities (Services,
	// Routes, and Consumers). It ensures that IDs remain stable across restarts of the controller.
	FillIDsFeature = "FillIDs"

	// RewriteURIsFeature is the name of the feature-gate for enabling/disabling konghq.com/rewrite annotation.
	RewriteURIsFeature = "RewriteURIs"

	// KongServiceFacade is the name of the feature-gate for enabling KongServiceFacade CR reconciliation.
	KongServiceFacade = "KongServiceFacade"

	// SanitizeKonnectConfigDumps is the name of the feature-gate that enables sanitization of Konnect config dumps.
	SanitizeKonnectConfigDumps = "SanitizeKonnectConfigDumps"

	// FallbackConfiguration is the name of the feature-gate that enables generating fallback configuration in the case
	// of entity errors returned by the Kong Admin API.
	FallbackConfiguration = "FallbackConfiguration"

	// KongCustomEntity is the name of the feature-gate for enabling KongCustomEntity CR reconciliation
	// for configuring custom Kong entities that KIC does not support yet.
	// Requires feature gate `FillIDs` to be enabled.
	KongCustomEntity = "KongCustomEntity"

	// CombinedServicesFromDifferentHTTPRoutes is the name of the feature gate that enables combining rules sharing the same backendRefs
	// from different HTTPRoutes in the same namespace into one Kong gateway service to reduce total number of Kong gateway services.
	CombinedServicesFromDifferentHTTPRoutes = "CombinedServicesFromDifferentHTTPRoutes"

	// DocsURL provides a link to the documentation for feature gates in the KIC repository.
	DocsURL = "https://github.com/Kong/kubernetes-ingress-controller/blob/main/FEATURE_GATES.md"
)

Types

type FeatureGates

type FeatureGates map[string]bool

func GetFeatureGatesDefaults

func GetFeatureGatesDefaults() FeatureGates

GetFeatureGatesDefaults initializes a feature gate map given the currently supported feature gates options and derives defaults for them based on manager configuration options if present.

NOTE: if you're adding a new feature gate, it needs to be added here.

func New

func New(setupLog logr.Logger, featureGates map[string]bool) (FeatureGates, error)

New creates FeatureGates from the given feature gate map, overriding the default settings.

func (FeatureGates) Enabled

func (fg FeatureGates) Enabled(feature string) bool