features

Documentation

Index

• Constants
• func ConfigMapName() string
• func EnableDependencies()
• func GetFeatureArgName(featureName string) string
• func GetFeatureMap() map[string]bool
• func Init(cmd *cobra.Command) error
• func IsGatewayEnabled(spec api.DeploymentSpec) bool
• func Iterate(iterator Iterator)
• func Supported(f Feature, v driver.Version, enterprise bool) bool
• type Feature
  • func AgencyPoll() Feature
  • func AsyncBackupCreation() Feature
  • func BackupCleanup() Feature
  • func DeploymentSpecDefaultsRestore() Feature
  • func EncryptionRotation() Feature
  • func EnforcedResignLeadership() Feature
  • func EphemeralVolumes() Feature
  • func FailoverLeadership() Feature
  • func Gateway() Feature
  • func GracefulShutdown() Feature
  • func InitContainerCopyResources() Feature
  • func InitContainerUpscaleResources() Feature
  • func JWTRotation() Feature
  • func LocalStorageReclaimPolicyPass() Feature
  • func LocalVolumeReplacementCheck() Feature
  • func Maintenance() Feature
  • func MetricsExporter() Feature
  • func OptionalGracefulShutdown() Feature
  • func RandomPodNames() Feature
  • func RebalancerV2() Feature
  • func RebuildOutSyncedShards() Feature
  • func RestartPolicyAlways() Feature
  • func SecuredContainers() Feature
  • func SensitiveInformationProtection() Feature
  • func ShortPodNames() Feature
  • func TLSRotation() Feature
  • func TLSSNI() Feature
  • func Timezone() Feature
  • func UpgradeAlternativeOrder() Feature
  • func UpgradeVersionCheck() Feature
  • func UpgradeVersionCheckV2() Feature
  • func Version310() Feature
• type Features
  • func (f Features) Get(name string) (Feature, bool)
  • func (f Features) Sort()
• type Iterator

Constants

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

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

const MinSupportedArangoDBVersion = "3.8.0"

Functions

func ConfigMapName

func ConfigMapName() string

func EnableDependencies

func EnableDependencies()

EnableDependencies enables dependencies for features if it is required.

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 IsGatewayEnabled

func IsGatewayEnabled(spec api.DeploymentSpec) bool

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. - any feature dependency 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
	Dependencies() []Feature
	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
	GetDependencies() []string
}

func AgencyPoll

func AgencyPoll() Feature

func AsyncBackupCreation

func AsyncBackupCreation() Feature

AsyncBackupCreation returns mode for backup creation (sync/async).

func BackupCleanup

func BackupCleanup() Feature

BackupCleanup returns mode for Imported backups cleanup.

func DeploymentSpecDefaultsRestore

func DeploymentSpecDefaultsRestore() Feature

func EncryptionRotation

func EncryptionRotation() Feature

func EnforcedResignLeadership

func EnforcedResignLeadership() Feature

EnforcedResignLeadership returns enforced ResignLeadership.

func EphemeralVolumes

func EphemeralVolumes() Feature

func FailoverLeadership

func FailoverLeadership() Feature

func Gateway

func Gateway() Feature

func GracefulShutdown

func GracefulShutdown() Feature

func InitContainerCopyResources

func InitContainerCopyResources() Feature

func InitContainerUpscaleResources

func InitContainerUpscaleResources() 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 RebalancerV2

func RebalancerV2() Feature

func RebuildOutSyncedShards

func RebuildOutSyncedShards() Feature

func RestartPolicyAlways

func RestartPolicyAlways() Feature

func SecuredContainers

func SecuredContainers() Feature

SecuredContainers returns secured containers 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 UpgradeAlternativeOrder

func UpgradeAlternativeOrder() Feature

func UpgradeVersionCheck

func UpgradeVersionCheck() Feature

func UpgradeVersionCheckV2

func UpgradeVersionCheckV2() Feature

func Version310

func Version310() Feature

type Features

type Features []Feature

func (Features) Get

func (f Features) Get(name string) (Feature, bool)

func (Features) Sort

func (f Features) Sort()

type Iterator

type Iterator func(name string, feature Feature)

Iterator defines feature definition iterator