scale

type Direction string

type GroupReq struct {

	// Direction is the scaling direction which the group is requested to change.
	Direction Direction

	// Count is the number by which to change the count by in the desired direction. This
	// information can also be found within the GroupScalingPolicy, but the API and the internal
	// autoscaler have different ways in which to process data so it is their responsibility to
	// populate this field for use and moves this logic away from the trigger.
	Count int

	// GroupName is the name of the job group to scale in this request.
	GroupName string

	// GroupScalingPolicy should include the job group scaling policy if it exists within the
	// Sherpa server.
	GroupScalingPolicy *policy.GroupScalingPolicy

	// Time is the UnixNano time representation which indicates when this scaling request was first
	// triggered. This is to help coordinate with checks such as cooldown and ensure a single time
	// can be used.
	Time int64

	// Meta is the meta data which is optionally submitted when requesting a scaling activity for a
	// job group. This is free-form and can contain any information the user deems relevant.
	Meta map[string]string
}

type Scale interface {
	// Trigger performs scaling of 1 or more job groups which belong to the same job.
	Trigger(string, []*GroupReq, state.Source) (*ScalingResponse, int, error)

	// GetDeploymentChannel is used to return the channel where updates to Nomad deployments should
	// be sent.
	GetDeploymentChannel() chan interface{}

	// RunDeploymentUpdateHandler is used to trigger the long running process which handles
	// messages sent to the deployment update channel.
	RunDeploymentUpdateHandler()

	// JobGroupIsDeploying checks internal references to identify if the queried job group is
	// currently in deployment.
	JobGroupIsDeploying(job, group string) bool

	// JobGroupIsInCooldown checks whether the job group in question is currently in scaling
	// cooldown using the input time as the comparison.
	JobGroupIsInCooldown(job, group string, cooldown int, time int64) (bool, error)
	// contains filtered or unexported methods
}

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

type ScalingResponse struct {
	ID           uuid.UUID
	EvaluationID string
}