policy

type ConfigDefaults ¶ added in v0.1.0

type ConfigDefaults struct {
	DefaultEvaluationInterval time.Duration
	DefaultCooldown           time.Duration
}

ConfigDefaults holds default configuration for unspecified values.

type Handler ¶

type Handler struct {
	// contains filtered or unexported fields
}

Handler monitors a policy for changes and controls when them are sent for evaluation.

func NewHandler(ID PolicyID, log hclog.Logger, pm *manager.PluginManager, ps Source) *Handler

func (h *Handler) Run(ctx context.Context, evalCh chan<- *sdk.ScalingEvaluation)

func (h *Handler) Stop()

type IDMessage ¶ added in v0.1.0

type IDMessage struct {
	IDs    []PolicyID
	Source SourceName
}

IDMessage encapsulates the required information that allows the policy manager to launch the correct MonitorPolicy interface function where it needs to handle policies which originate from different sources.

type Manager ¶

type Manager struct {
	// contains filtered or unexported fields
}

Manager tracks policies and controls the lifecycle of each policy handler.

func NewManager(log hclog.Logger, ps map[SourceName]Source, pm *manager.PluginManager, mInt time.Duration) *Manager

func (m *Manager) EnforceCooldown(id string, t time.Duration)

func (m *Manager) ReloadSources()

func (m *Manager) Run(ctx context.Context, evalCh chan<- *sdk.ScalingEvaluation)

type MonitorIDsReq ¶ added in v0.1.0

type MonitorIDsReq struct {
	ErrCh    chan<- error
	ResultCh chan<- IDMessage
}

type MonitorPolicyReq ¶ added in v0.1.0

type MonitorPolicyReq struct {
	ID       PolicyID
	ErrCh    chan<- error
	ReloadCh <-chan struct{}
	ResultCh chan<- sdk.ScalingPolicy
}

type Mutations ¶ added in v0.3.4

type Mutations []string

Mutations is a list of human-friendly descriptions of the changes performed by a mutator.

type Mutator ¶ added in v0.3.4

type Mutator interface {
	MutatePolicy(*sdk.ScalingPolicy) Mutations
}

Mutator is an interface used to apply changes to a scaling policy.

type NomadAPMMutator ¶ added in v0.3.4

type NomadAPMMutator struct{}

NomadAPMMutator handles the special case for zero count cluster scaling since it can't query nodes if there are none running.

func (m NomadAPMMutator) MutatePolicy(p *sdk.ScalingPolicy) Mutations

type PolicyID ¶

type PolicyID string

PolicyID contains identifying information about a policy, as returned by policy.Source.MonitorIDs()

func (p PolicyID) String() string

type Processor ¶ added in v0.1.1

type Processor struct {
	// contains filtered or unexported fields
}

Processor helps process policies and perform common actions on them when they are discovered from their source.

func NewProcessor(defaults *ConfigDefaults, apms []string) *Processor

func (pr *Processor) ApplyPolicyDefaults(p *sdk.ScalingPolicy)

func (pr *Processor) CanonicalizeAPMQuery(c *sdk.ScalingPolicyCheck, t *sdk.ScalingPolicyTarget)

func (pr *Processor) CanonicalizeCheck(c *sdk.ScalingPolicyCheck, t *sdk.ScalingPolicyTarget)

func (pr *Processor) ValidatePolicy(p *sdk.ScalingPolicy) error

type Source ¶

type Source interface {
	MonitorIDs(ctx context.Context, monitorIDsReq MonitorIDsReq)
	MonitorPolicy(ctx context.Context, monitorPolicyReq MonitorPolicyReq)

	// Name returns the SourceName for the implementation. This helps handlers
	// identify the source implementation which is responsible for policies.
	Name() SourceName

	// ReloadIDsMonitor is used to trigger a reload of the MonitorIDs routine
	// so that config items can be reloaded gracefully without restarting the
	// agent.
	ReloadIDsMonitor()
}

Source is the interface that must be implemented by backends which provide the canonical source for scaling policies.

type SourceName ¶ added in v0.1.0

type SourceName string

SourceName differentiates policies from different sources. This allows the policy manager to use the correct Source interface implementation to launch the MonitorPolicy function for the PolicyID.

const (
	// SourceNameNomad is the source for policies that originate from the Nomad
	// scaling policies API.
	SourceNameNomad SourceName = "nomad"

	// SourceNameFile is the source for policies that are loaded from disk.
	SourceNameFile SourceName = "file"

	// SourceNameHA is the source for HA policy sources
	SourceNameHA SourceName = "ha"
)