# Packages

No description provided by the author

# Functions

NewScalingEvaluation creates a new ScalingEvaluation based off the passed policy and status.
NewTargetScalingNoOpError returns a new target scaling no-op error with the provided formatted message.
PreemptScalingAction determines which ScalingAction should take precedence.

# Constants

PluginTypeAPM is a plugin which satisfies the APM interface.
PluginTypeBase is plugin component that all plugins must implement.
PluginTypeStrategy is a plugin which satisfies the Strategy interface.
PluginTypeTarget is a plugin which satisfies the Target interface.
ScaleDirectionDown indicates the target should lower the number of running instances of the resource.
ScaleDirectionNone indicates no scaling is required.
ScaleDirectionUp indicates the target should increase the number of running instances of the resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StrategyActionMetaValueDryRunCount is a special count value used when performing dry-run scaling activities.
TargetConfigKeyClass is the horizontal cluster scaling target config key which identifies nodes as part of a pool of resources using the clients node_class configuration param.
TargetConfigKeyDatacenter is the horizontal cluster scaling target config key which identifies nodes as part of a pool of resources using the agents datacenter configuration param.
TargetConfigKeyDrainDeadline is the config key which defines the override value to use when draining a Nomad client during the scale in action of horizontal cluster scaling.
TargetConfigKeyIgnoreSystemJobs is the config key which defines whether or not nomad system jobs are drained during the drain operation.
TargetConfigKeyJob is the config key used within horizontal app scaling to identify the Nomad job targeted for autoscaling.
TargetConfigKeyNamespace is the config key used within horizontal app scaling to identify the Nomad namespace targeted for autoscaling.
TargetConfigKeyNodePool is the horizontal cluster scaling target config key which identifies nodes as part of a pool of resources using the clients node_pool configuration param.
TargetConfigKeyNodePurge is the config key which defines whether or not Nomad clients are purged from Nomad once they have been terminated within their provider.
TargetConfigKeyTaskGroup is the config key used within horizontal app scaling to identify the Nomad job group targeted for autoscaling.
TargetConfigNodeSelectorStrategy is the optional node target config option which dictates how the Nomad Autoscaler selects nodes when scaling in.
TargetNodeSelectorStrategyEmpty is the cluster scale-in node selection strategy that only picks nodes without non-terminal allocations.
TargetNodeSelectorStrategyEmptyIgnoreSystemJobs is the cluster scale-in node selection strategy that only picks nodes without non-terminal allocations, without considering system jobs.
TargetNodeSelectorStrategyLeastBusy is the cluster scale-in node selection strategy that identifies nodes based on their CPU and Memory resource allocation.
TargetNodeSelectorStrategyNewestCreateIndex is the cluster scale-in node selection strategy that uses the sorting perform by the SDK.
TargetNodeSelectorStrategyEmptyIgnoreSystemJobs is the cluster scale-in node selection strategy that picks the oldest running nodes.
TargetStatusMetaKeyLastEvent is an optional meta key that can be added to the status return.

# Variables

TargetConfigConflictingClusterParams is a list containing horizontal cluster scaling target configuration options which conflict.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
FileDecodeScalingPolicy is used as an intermediate step when decoding a policy from a file.
ScalingAction represents a strategy plugins intention to change the current target state.
ScalingCheckEvaluation is the evaluation of an individual policy check.
ScalingEvaluation forms an individual analysis undertaken by the autoscaler in order to determine the desired state of a target.
ScalingPolicy is the internal representation of a scaling document and encompasses all the required information for the autoscaler to perform scaling evaluations on a target.
ScalingPolicyCheck is an individual check within a scaling policy.This check will be executed in isolation alongside other checks within the policy.
ScalingPolicyStrategy contains the plugin and configuration details for calculating the desired target state from the current state.
ScalingPolicyTarget identifies the target for which the ScalingPolicy as a whole is configured for.
TargetScalingNoOpError is a special error type that can be used by target plugins to indicate that a scaling request didn't result in any action, but didn't fail either.
TargetStatus is the response object when performing the Status call of the target plugin interface.
TimeRange defines a range of time.
TimestampedMetric contains a single metric Value along with its associated Timestamp.

# Type aliases

ScaleDirection is an identifier used by strategy plugins to identify how the target should scale the named resource.
TimestampedMetrics is an array of timestamped metric values.