state

Documentation

Index

• func ContainsProfile(allProfiles, profile string) bool
• type ApplyResult
  • func Apply(state NodeState, node *v1.Node, data *DataV2, params plugin.Parameters) (ApplyResult, error)
• type Data
  • func ParseData(dataStr string) (Data, error)
• type DataV2
  • func ParseDataV2(dataStr string) (DataV2, error)
  • func ParseMigrateDataV2(dataStr string, log logr.Logger) (DataV2, error)
  • func (d *DataV2) GetProfilesWithState(profilesStr string, availableProfiles map[string]Profile) []ProfileState
  • func (d *DataV2) MaintainProfileStates(profilesStr string, availableProfiles map[string]Profile)
• type NodeInfo
• type NodeState
  • func FromLabel(label NodeStateLabel, chains PluginChains) (NodeState, error)
• type NodeStateLabel
  • func ValidateLabel(s string) (NodeStateLabel, error)
• type PluginChains
• type Profile
• type ProfileData
• type ProfileResult
• type ProfileSelector
• type ProfileState
• type Transition
  • func (t *Transition) Execute(params plugin.Parameters) (TransitionResult, error)
• type TransitionResult
• type TransitionsResult

Functions

func ContainsProfile

func ContainsProfile(allProfiles, profile string) bool

Returns whether profile is contained in the profile label value.

Types

type ApplyResult

type ApplyResult struct {
	Next        NodeStateLabel     `json:"next"`
	Transitions []TransitionResult `json:"transitions"`
	Error       string             `json:"error"`
}

func Apply

func Apply(state NodeState, node *v1.Node, data *DataV2, params plugin.Parameters) (ApplyResult, error)

Calls all Notification Plugins, checks for a transition and invokes all trigger plugins if a transitions happens. Returns the next node state. In case of an error state.Label() is retuned alongside with the error.

type Data

type Data struct {
	LastTransition time.Time
	// Maps a notification instance name to the last time it was triggered.
	LastNotificationTimes map[string]time.Time
	// Current states of assigned profiles
	ProfileStates map[string]NodeStateLabel
	// States of profiles of the previous reconciliation
	PreviousStates map[string]NodeStateLabel
}

Data represents global state which is saved with a node annotation.

func ParseData

func ParseData(dataStr string) (Data, error)

type DataV2

type DataV2 struct {
	Profiles map[string]*ProfileData
	// Maps a notification instance name to the last time it was triggered.
	Notifications map[string]time.Time
}

func ParseDataV2

func ParseDataV2(dataStr string) (DataV2, error)

func ParseMigrateDataV2

func ParseMigrateDataV2(dataStr string, log logr.Logger) (DataV2, error)

func (*DataV2) GetProfilesWithState

func (d *DataV2) GetProfilesWithState(profilesStr string, availableProfiles map[string]Profile) []ProfileState

Returns a Profile instance with its corresponding state for each profile named in profileStr. If profileStr is an empty string, falls back to the default profile. Call MaintainProfileStates before.

func (*DataV2) MaintainProfileStates

func (d *DataV2) MaintainProfileStates(profilesStr string, availableProfiles map[string]Profile)

Removes state data for removed profile and initializes it for added profiles.

type NodeInfo

type NodeInfo struct {
	Node     string            `json:"node"`
	Profiles []ProfileResult   `json:"profiles"`
	Labels   map[string]string `json:"labels"`
	Updated  time.Time         `json:"updated"`
}

type NodeState

type NodeState interface {
	// Label is the Label associated with the state
	Label() NodeStateLabel
	// Enter is executed when a node enters a new state.
	// Its not executed when a profile gets freshly attached.
	Enter(params plugin.Parameters, data *DataV2) error
	// Notify executes the notification chain if required
	Notify(params plugin.Parameters, data *DataV2) error
	// Trigger executes the trigger chain
	Trigger(params plugin.Parameters, next NodeStateLabel, data *DataV2) error
	// Trigger executes the check chain and determines, which state should be the next one.
	// If an error is returned the NodeStateLabel must match the current state.
	Transition(params plugin.Parameters, data *DataV2) (TransitionsResult, error)
}

NodeState represents the state a node can be in.

func FromLabel

func FromLabel(label NodeStateLabel, chains PluginChains) (NodeState, error)

FromLabel creates a new NodeState instance identified by the label with given chains and notification interval.

type NodeStateLabel

type NodeStateLabel string

NodeStateLabel reprensents labels which nodes a marked with.

const InMaintenance NodeStateLabel = "in-maintenance"

InMaintenance is a label that marks a node which is currently in maintenance.

const Operational NodeStateLabel = "operational"

Operational is a label that marks a node which is operational.

const Required NodeStateLabel = "maintenance-required"

Required is a label that marks a node which needs to be maintenaned.

func ValidateLabel

func ValidateLabel(s string) (NodeStateLabel, error)

Returns whether s as NodeStateLabel if it is valid.

type PluginChains

type PluginChains struct {
	Enter        plugin.TriggerChain
	Notification plugin.NotificationChain
	Transitions  []Transition
}

PluginChains is a struct containing a plugin chain of each plugin type.

type Profile

type Profile struct {
	Name   string
	Chains map[NodeStateLabel]PluginChains
}

Profile contains its name and attached plugin chains.

type ProfileData

type ProfileData struct {
	Transition time.Time
	Current    NodeStateLabel
	Previous   NodeStateLabel
}

type ProfileResult

type ProfileResult struct {
	Applied ApplyResult    `json:"applied"`
	Name    string         `json:"name"`
	State   NodeStateLabel `json:"state"`
}

type ProfileSelector

type ProfileSelector struct {
	NodeState         NodeStateLabel
	NodeProfiles      string
	AvailableProfiles map[string]Profile
	Data              Data
}

type ProfileState

type ProfileState struct {
	Profile Profile
	State   NodeStateLabel
}

type Transition

type Transition struct {
	Check   plugin.CheckChain
	Trigger plugin.TriggerChain
	Next    NodeStateLabel
}

func (*Transition) Execute

func (t *Transition) Execute(params plugin.Parameters) (TransitionResult, error)

type TransitionResult

type TransitionResult struct {
	Passed bool                    `json:"passed"`
	Target NodeStateLabel          `json:"target"`
	Chain  plugin.CheckChainResult `json:"chain"`
	Error  string                  `json:"error"`
}

type TransitionsResult

type TransitionsResult struct {
	Next  NodeStateLabel     `json:"next"`
	Infos []TransitionResult `json:"infos"`
}