autoscaler

Documentation

Index

• func SixtyFourGiBNodeNumToTopologySize(nodeNum int) int
• type AutoScaler
  • func New(config *Config) (*AutoScaler, error)
  • func (a *AutoScaler) CalcScalingOperation(ctx context.Context) (*ScalingOperation, error)
  • func (a *AutoScaler) Run(ctx context.Context) (*ScalingOperation, error)
• type AutoScalingConfig
• type Config
• type ScalingConfig
• type ScalingDirection
• type ScalingOperation
  • func (s *ScalingOperation) Direction() ScalingDirection
  • func (s *ScalingOperation) NeedTopologySizeUpdate() bool
• type ScalingThresholdDurationMinute
• type ScheduledScalingConfig

Functions

func SixtyFourGiBNodeNumToTopologySize

func SixtyFourGiBNodeNumToTopologySize(nodeNum int) int

Types

type AutoScaler

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

func New

func New(config *Config) (*AutoScaler, error)

func (*AutoScaler) CalcScalingOperation

func (a *AutoScaler) CalcScalingOperation(ctx context.Context) (*ScalingOperation, error)

func (*AutoScaler) Run

func (a *AutoScaler) Run(ctx context.Context) (*ScalingOperation, error)

Run executes scale in/out if needed based on the configuration This method will return non-nil ScalingOperation with error when error happens after scaling operation is decided

type AutoScalingConfig

type AutoScalingConfig struct {
	MetricsProvider metrics.Provider `yaml:"-" validate:"required"`
	// DesiredCPUUtilPercent is desired CPU utilization percent
	// Autoscaler will change nodes to make CPU utilization closer to the desired CPU utilization.
	DesiredCPUUtilPercent int `yaml:"desiredCPUUtilPercent" validate:"required,gt=0,lt=100"`

	// ScaleOutThresholdDuration is a threshold duration for scale-out.
	// When CPU util is higher than DesiredCPUUtilPercent throughout the threshold duration
	// scale-out may happen
	ScaleOutThresholdDuration time.Duration `yaml:"scaleOutThresholdDuration" validate:"gte=0"`
	// ScaleOutCoolDownDuration is a cool down period for scale-out after the last scaling operation
	ScaleOutCoolDownDuration time.Duration `yaml:"scaleOutCoolDownDuration" validate:"gte=0"`

	// ScaleInThresholdDuration is a threshold duration for scale-in
	// When CPU util is lower than DesiredCPUUtilPercent throughout the threshold duration
	// scale-in may happen
	ScaleInThresholdDuration time.Duration `yaml:"scaleInThresholdDuration" validate:"gte=0"`
	// ScaleInCoolDownDuration is a cool down period for scale-in after the last scaling operation
	ScaleInCoolDownDuration time.Duration `yaml:"scaleInCoolDownDuration" validate:"gte=0"`
}

type Config

type Config struct {
	ElasticCloudClient  *api.API                   `validate:"required"`
	DeploymentID        string                     `validate:"required"`
	ElasticsearchClient *elasticsearch.TypedClient `validate:"required"`

	Scaling ScalingConfig `validate:"required"`
	// DryRun disables applying actual scaling operation
	DryRun bool
}

type ScalingConfig

type ScalingConfig struct {
	// Index to update replicas when scaling out/in
	Index string `yaml:"index" validate:"required"`
	// ShardsPerNode is desired shard count per 1 node
	// Autoscaler won't scale-in / scale-out to the node count that can't meet this ratio.
	ShardsPerNode int `yaml:"shardsPerNode" validate:"required,gte=1"`
	// Default memory min size per zone. It can be overwritten by ScheduledScalingConfig.MinMemoryGBPerZone.
	// Available number is only 64,...(64xN node)
	// If you have multiple zone, this memory is per zone.
	// NOTE: Currently we only support 64GB node for simplicity
	DefaultMinMemoryGBPerZone int `yaml:"defaultMinMemoryGBPerZone" validate:"gte=64"`
	// Default memory max size per zone. It can be overwritten by ScheduledScalingConfig.MaxMemoryGBPerZone.
	// Available number is only 64,...(64xN node)
	// If you have multiple zone, this memory is per zone.
	// NOTE: Currently we only support 64GB node for simplicity
	DefaultMaxMemoryGBPerZone int `yaml:"defaultMaxMemoryGBPerZone" validate:"gte=64,gtefield=DefaultMinMemoryGBPerZone"`

	AutoScaling *AutoScalingConfig `yaml:"autoScaling"`
	// If the time is within multiple schedules, the last schedule will be applied
	// e.g. [{min: 1, max: 2}, {min:2, max:4}] => min: 2, max: 4
	ScheduledScalings []*ScheduledScalingConfig `yaml:"scheduledScalings"`
}

type ScalingDirection

type ScalingDirection string

const (
	ScalingDirectionOut  ScalingDirection = "SCALING_OUT"
	ScalingDirectionIn   ScalingDirection = "SCALING_IN"
	ScalingDirectionNone ScalingDirection = "NOT_SCALING"
)

type ScalingOperation

type ScalingOperation struct {
	FromTopologySize *models.TopologySize
	ToTopologySize   *models.TopologySize
	FromReplicaNum   int
	ToReplicaNum     int
	Reason           string
}

func (*ScalingOperation) Direction

func (s *ScalingOperation) Direction() ScalingDirection

func (*ScalingOperation) NeedTopologySizeUpdate

func (s *ScalingOperation) NeedTopologySizeUpdate() bool

type ScalingThresholdDurationMinute

type ScalingThresholdDurationMinute int

type ScheduledScalingConfig

type ScheduledScalingConfig struct {
	// StartCronSchedule is cron format schedule to start the specified min/max size.
	// default timezone is machine local timezone,
	// if you want to specify, set TZ= prefix (e.g. `TZ=UTC 0 0 0 0 0`)
	StartCronSchedule string `yaml:"startCronSchedule" validate:"required"`
	// Duration to apply above min/max size from StartCronSchedule
	Duration time.Duration `yaml:"duration" validate:"gt=0"`
	// MinMemoryGBPerZone is the minimum memory size during the specified period
	// NOTE: Currently we only support 64GB node for simplicity
	MinMemoryGBPerZone int `yaml:"minMemoryGBPerZone" validate:"gte=64"`
	// MaxMemoryGBPerZone is the maximum memory size during the specified period
	// NOTE: Currently we only support 64GB node for simplicity
	MaxMemoryGBPerZone int `yaml:"maxMemoryGBPerZone" validate:"gte=64,gtefield=MinMemoryGBPerZone"`
}

ScheduledScalingConfig represents scheduled min/max memory max size within the period