features

Documentation

Index

• Constants
• type FeatureGate
  • func NewDefaultFeatureGate() FeatureGate
  • func NewFeatureGate() FeatureGate

Constants

const (
	// StableScheduling controls stable scheduling of TiDB members.
	StableScheduling string = "StableScheduling"

	// AdvancedStatefulSet controls whether to use AdvancedStatefulSet to manage pods
	AdvancedStatefulSet string = "AdvancedStatefulSet"

	// AutoScaling controls whether to use TidbClusterAutoScaler to auto scale-in/out pods
	AutoScaling string = "AutoScaling"

	// VolumeModifying controls whether allow to modify volumes
	// NOTE: volume resize is always allowed even if this feature is disabled
	VolumeModifying string = "VolumeModifying"

	// VolumeReplacing controls whether to replace whole volumes by deleting and recreating on changes.
	// tidb, tikv & pd supported. If enabled takes precedence over resizing/modifying.
	VolumeReplacing string = "VolumeReplacing"
)

Types

type FeatureGate

type FeatureGate interface {
	// AddFlag adds a flag for setting global feature gates to the specified FlagSet.
	AddFlag(flagset *flag.FlagSet)
	// Enabled returns true if the key is enabled.
	Enabled(key string) bool
	// Set parses and stores flag gates for known features
	// from a string like feature1=true,feature2=false,...
	Set(value string) error
	// SetFromMap stores flag gates for enabled features from a map[string]bool
	SetFromMap(m map[string]bool)
	// String returns a string representation of feature gate.
	String() string
}

var (

	// DefaultFeatureGate is a shared global FeatureGate.
	DefaultFeatureGate FeatureGate = NewDefaultFeatureGate()
)

func NewDefaultFeatureGate

func NewDefaultFeatureGate() FeatureGate

func NewFeatureGate

func NewFeatureGate() FeatureGate