features

Documentation

Index

• Constants
• func ConfigMapName() string
• func GetFeatureArgName(featureName string) string
• func GetFeatureMap() map[string]bool
• func Init(cmd *cobra.Command) error
• func Iterate(iterator Iterator)
• func Supported(f Feature, v driver.Version, enterprise bool) bool
• type Feature
  • func AgencyPoll() Feature
  • func DeploymentSpecDefaultsRestore() Feature
  • func EncryptionRotation() Feature
  • func EphemeralVolumes() Feature
  • func FailoverLeadership() Feature
  • func GracefulShutdown() Feature
  • func JWTRotation() Feature
  • func LocalStorageReclaimPolicyPass() Feature
  • func LocalVolumeReplacementCheck() Feature
  • func Maintenance() Feature
  • func MetricsExporter() Feature
  • func OptionalGracefulShutdown() Feature
  • func RandomPodNames() Feature
  • func RebuildOutSyncedShards() Feature
  • func RestartPolicyAlways() Feature
  • func SensitiveInformationProtection() Feature
  • func ShortPodNames() Feature
  • func TLSRotation() Feature
  • func TLSSNI() Feature
  • func Timezone() Feature
  • func UpgradeVersionCheck() Feature
  • func Version310() Feature
• type Iterator

Constants

const (
	Enabled  = "true"
	Disabled = "false"
)

const (
	DefaultFeaturesConfigMap = "arangodb-operator-feature-config-map"
)

Functions

func ConfigMapName

func ConfigMapName() string

func GetFeatureArgName

func GetFeatureArgName(featureName string) string

GetFeatureArgName returns feature process argument name.

func GetFeatureMap

func GetFeatureMap() map[string]bool

GetFeatureMap returns all features' arguments names.

func Init

func Init(cmd *cobra.Command) error

Init initializes all registered features. If a feature is not provided via process's argument, then it is taken from environment variable or from enabled by default setting.

func Iterate

func Iterate(iterator Iterator)

Iterate allows to iterate over all registered functions

func Supported

func Supported(f Feature, v driver.Version, enterprise bool) bool

Supported returns false when: - feature is disabled. - a given version is lower than minimum feature version. - feature expects enterprise but a given enterprise arg is not true.

Types

type Feature

type Feature interface {
	Name() string
	Description() string
	Version() driver.Version
	EnterpriseRequired() bool
	OperatorEnterpriseRequired() bool
	EnabledByDefault() bool
	Enabled() bool
	EnabledPointer() *bool
	Deprecated() (bool, string)
	Hidden() bool
	Supported(v driver.Version, enterprise bool) bool
	ImageSupported(i *api.ImageInfo) bool
}

func AgencyPoll

func AgencyPoll() Feature

func DeploymentSpecDefaultsRestore

func DeploymentSpecDefaultsRestore() Feature

func EncryptionRotation

func EncryptionRotation() Feature

func EphemeralVolumes

func EphemeralVolumes() Feature

func FailoverLeadership

func FailoverLeadership() Feature

func GracefulShutdown

func GracefulShutdown() Feature

func JWTRotation

func JWTRotation() Feature

func LocalStorageReclaimPolicyPass

func LocalStorageReclaimPolicyPass() Feature

func LocalVolumeReplacementCheck

func LocalVolumeReplacementCheck() Feature

func Maintenance

func Maintenance() Feature

func MetricsExporter

func MetricsExporter() Feature

deprecated

func OptionalGracefulShutdown

func OptionalGracefulShutdown() Feature

func RandomPodNames

func RandomPodNames() Feature

func RebuildOutSyncedShards

func RebuildOutSyncedShards() Feature

func RestartPolicyAlways

func RestartPolicyAlways() Feature

func SensitiveInformationProtection

func SensitiveInformationProtection() Feature

func ShortPodNames

func ShortPodNames() Feature

func TLSRotation

func TLSRotation() Feature

func TLSSNI

func TLSSNI() Feature

func Timezone

func Timezone() Feature

func UpgradeVersionCheck

func UpgradeVersionCheck() Feature

func Version310

func Version310() Feature

type Iterator

type Iterator func(name string, feature Feature)

Iterator defines feature definition iterator