feature

Documentation

Index

• Constants
• Variables
• type Defaults
• type FeatureSet
  • func FromDefaults(d Defaults) FeatureSet
  • func (s FeatureSet) Get(name string) bool
  • func (s FeatureSet) Set(name string, enabled bool) error
  • func (s FeatureSet) ToEnabled() map[string]bool
• type ObsoleteError
  • func (s ObsoleteError) Error() string
• type Status
• type Value

Constants

const Events = "events"

const MultipleContainersPerPod = "multiple_containers_per_pod"

const Snapshots = "snapshots"

Variables

var MainDefaults = Defaults{
	MultipleContainersPerPod: Value{
		Enabled: true,
		Status:  Active,
	},
	Events: Value{
		Enabled: true,
		Status:  Active,
	},
	Snapshots: Value{
		Enabled: false,
		Status:  Active,
	},
}

MainDefaults is the defaults we use in Main

Types

type Defaults

type Defaults map[string]Value

Defaults is the initial values for a FeatureSet. Don't modify after initializing.

type FeatureSet

type FeatureSet map[string]Value

FeatureSet is a mutable set of Features.

func FromDefaults

func FromDefaults(d Defaults) FeatureSet

Create a FeatureSet from defaults.

func (FeatureSet) Get

func (s FeatureSet) Get(name string) bool

Get gets whether a feature is enabled.

func (FeatureSet) Set

func (s FeatureSet) Set(name string, enabled bool) error

Set sets enabled for a feature if it's active. Returns an error if flag is unknown or obsolete.

func (FeatureSet) ToEnabled

func (s FeatureSet) ToEnabled() map[string]bool

ToEnabled returns a copy of the enabled values of the FeatureSet

type ObsoleteError

type ObsoleteError string

ObsoleteError is an error that a feature flag is obsolete

func (ObsoleteError) Error

func (s ObsoleteError) Error() string

type Status

type Status int

The status of a feature flag It starts as Active (we're using this flag to evaluate the feature) Then when we no longer need it, we make it a noop. Leave it for an upgrade cycle. Then move it to Obsolete, which will cause a warning. Leave it for an upgrade cycle. Then remove the flag altogether.

const (
	Active Status = iota
	Noop
	Obsolete
)

type Value

type Value struct {
	Enabled bool
	Status  Status
}

The Value a flag can have. Status should never be changed.