api-docs.asciidoc

API Reference

Packages

• core.kubestitute.quortex.io/v1alpha1

  • Instance

  • PriorityExpander

  • Scheduler

core.kubestitute.quortex.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group

Resource Types

• Instance

• PriorityExpander

• Scheduler

AdvancedSchedulerPolicy

AdvancedSchedulerPolicy is a policy that allow arithmetic operation to compute replicas.

Appears In:

• ScaleUpRules

Field	Description
leftOperand IntOrField	LeftOperand is the left operand of the comparison. It could be the target ASG Health field from which this policy is applied or an integer.
operator ComparisonOperator	A comparison operator used to apply policy between From and To.
rightOperand IntOrField	RightOperand is the left operand of the comparison. It could be the target ASG Health field from which this policy is applied or an integer.
periodSeconds integer	PeriodSeconds specifies the window of time for which the policy should hold true.
replicas IntOrArithmeticOperation	Replicas specify the replicas to Scale.

ArithmeticOperation

ArithmeticOperation describes an arithmetic operation.

Appears In:

• IntOrArithmeticOperation

Field	Description
leftOperand IntOrField	LeftOperand is the left operand of the operation.
operator ArithmeticOperator	An arithmetic operator used to apply policy between From and To.
rightOperand IntOrField	RightOperand is the right operand of the operation.

ArithmeticOperator(string)

ArithmeticOperator describes arithmetic operators

Appears In:

• ArithmeticOperation

ComparisonOperator(string)

ComparisonOperator describes comparison operators

Appears In:

• AdvancedSchedulerPolicy

• SchedulerPolicy

Field(string)

Field describes a SchedulerPolicy Field. It is based on ASG health status.

Appears In:

• IntOrField

Instance

Instance is the Schema for the instances API

Field	Description
apiVersion string	core.kubestitute.quortex.io/v1alpha1
kind string	Instance
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec InstanceSpec

InstanceSpec

InstanceSpec defines the desired state of Instance

Appears In:

• Instance

Field	Description
autoscalingGroup string	The AutoScaling Group name.
honorCooldown boolean	Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

IntOrArithmeticOperation

IntOrArithmeticOperation is a type that can hold an int32 or an arithmetic operation.

Appears In:

• AdvancedSchedulerPolicy

Field	Description
int integer	An Int for value.
operation ArithmeticOperation	An arithmetic operation..

IntOrField

IntOrField is a type that can hold an int32 or a Field.

Appears In:

• AdvancedSchedulerPolicy

• ArithmeticOperation

• SchedulerPolicy

Field	Description
int integer	An Int for value.
field Field	An Field for value.

PriorityExpander

PriorityExpander is the Schema for the priorityexpanders API

Field	Description
apiVersion string	core.kubestitute.quortex.io/v1alpha1
kind string	PriorityExpander
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec PriorityExpanderSpec

PriorityExpanderSpec

PriorityExpanderSpec defines the desired state of PriorityExpander

Appears In:

• PriorityExpander

Field	Description
template string	The Go template to parse, which will generate the priority expander config map for cluster autoscaler to use.

ScaleDownRules

ScaleDownRules configures the scaling behavior for Instance scale downs.

Appears In:

• SchedulerSpec

Field	Description
stabilizationWindowSeconds integer	A cooldown for consecutive scale down operations.
policies SchedulerPolicy array	Policies is a list of potential scaling polices which can be evaluated for scaling decisions. At least one policy must be specified. Instances will be scaled down one by one.

ScaleUpRules

ScaleUpRules configures the scaling behavior for Instance scale ups.

Appears In:

• SchedulerSpec

Field	Description
stabilizationWindowSeconds integer	A cooldown for consecutive scale up operations.
policies AdvancedSchedulerPolicy array	Policies is a list of potential scaling polices which can be evaluated for scaling decisions. At least one policy must be specified. For scale ups the matching policy which triggers the highest number of replicas will be used.

Scheduler

Scheduler is the Schema for the schedulers API

Field	Description
apiVersion string	core.kubestitute.quortex.io/v1alpha1
kind string	Scheduler
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SchedulerSpec

SchedulerPolicy

SchedulerPolicy is a single policy which must hold true for a specified past interval.

Appears In:

• AdvancedSchedulerPolicy

• ScaleDownRules

Field	Description
leftOperand IntOrField	LeftOperand is the left operand of the comparison. It could be the target ASG Health field from which this policy is applied or an integer.
operator ComparisonOperator	A comparison operator used to apply policy between From and To.
rightOperand IntOrField	RightOperand is the left operand of the comparison. It could be the target ASG Health field from which this policy is applied or an integer.
periodSeconds integer	PeriodSeconds specifies the window of time for which the policy should hold true.

SchedulerSpec

SchedulerSpec defines the desired state of Scheduler

Appears In:

• Scheduler

Field	Description
trigger SchedulerTrigger	The Scheduler Trigger
autoscalingGroupTarget string	Name of the autoscaling group which the scheduler will use to apply the rules. Conflict with autoscalingGroupTargets.
autoscalingGroupTargets string array	List of autoscaling groups names which the scheduler will use to apply the rules. The values are summed. Conflict with autoscalingGroupTarget.
autoscalingGroupFallback string	Name of the autoscaling group in which the scheduler will trigger fallback instances. This autoscaling group must not be managed by the cluster-autoscaler. These ASG must not be managed by the cluster-autoscaler. Conflict with autoscalingGroupFallbacks.
autoscalingGroupFallbacks string array	List of autoscaling groups names in which the scheduler will trigger fallback instances. These ASG must not be managed by the cluster-autoscaler. Conflict with autoscalingGroupFallback.
scaleUpRules ScaleUpRules	Scheduler rules used to match criteria on Target ASG to trigger Scale Up on Fallback ASG.
scaleDownRules ScaleDownRules	Scheduler rules used to match criteria on Target ASG to trigger Scale Down on Fallback ASG.

SchedulerTrigger(string)

SchedulerTrigger describe a trigger for the Scheduler.

Appears In:

• SchedulerSpec