keda.sh/v1alpha1/ScaledObject

string

.apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

string

.kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

object

.metadata

object required

.spec

ScaledObjectSpec is the spec for a ScaledObject resource

object

.spec .advanced

AdvancedConfig specifies advance scaling options

object

.spec .advanced .horizontalPodAutoscalerConfig

HorizontalPodAutoscalerConfig specifies horizontal scale config

object

.spec .advanced .horizontalPodAutoscalerConfig .behavior

HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

object

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleDown

scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).

array

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleDown .policies

policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid

integer required

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleDown .policies[] .periodSeconds

periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).

string required

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleDown .policies[] .type

type is used to specify the scaling policy.

integer required

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleDown .policies[] .value

value contains the amount of change which is permitted by the policy. It must be greater than zero

string

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleDown .selectPolicy

selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.

integer

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleDown .stabilizationWindowSeconds

stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values:

For scale up: 0 (i.e. no stabilization is done).
For scale down: 300 (i.e. the stabilization window is 300 seconds long).

object

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleUp

scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:

increase no more than 4 pods per 60 seconds
double the number of pods per 60 seconds No stabilization is used.

array

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleUp .policies

policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid

integer required

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleUp .policies[] .periodSeconds

periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).

string required

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleUp .policies[] .type

type is used to specify the scaling policy.

integer required

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleUp .policies[] .value

value contains the amount of change which is permitted by the policy. It must be greater than zero

string

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleUp .selectPolicy

selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.

integer

.spec .advanced .horizontalPodAutoscalerConfig .behavior .scaleUp .stabilizationWindowSeconds

stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values:

For scale up: 0 (i.e. no stabilization is done).
For scale down: 300 (i.e. the stabilization window is 300 seconds long).

string

.spec .advanced .horizontalPodAutoscalerConfig .name

boolean

.spec .advanced .restoreToOriginalReplicaCount

object

.spec .advanced .scalingModifiers

ScalingModifiers describes advanced scaling logic options like formula

string

.spec .advanced .scalingModifiers .activationTarget

string

.spec .advanced .scalingModifiers .formula

string

.spec .advanced .scalingModifiers .metricType

MetricTargetType specifies the type of metric being targeted, and should be either “Value”, “AverageValue”, or “Utilization”

string

.spec .advanced .scalingModifiers .target

integer

.spec .cooldownPeriod

object

.spec .fallback

Fallback is the spec for fallback options

string

.spec .fallback .behavior

integer required

.spec .fallback .failureThreshold

integer required

.spec .fallback .replicas

integer

.spec .idleReplicaCount

integer

.spec .initialCooldownPeriod

integer

.spec .maxReplicaCount

integer

.spec .minReplicaCount

integer

.spec .pollingInterval

object required

.spec .scaleTargetRef

ScaleTarget holds the reference to the scale target Object

string

.spec .scaleTargetRef .apiVersion

string

.spec .scaleTargetRef .envSourceContainerName

string

.spec .scaleTargetRef .kind

string required

.spec .scaleTargetRef .name

array required

.spec .triggers

object

.spec .triggers[] .authenticationRef

AuthenticationRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that is used to authenticate the scaler with the environment

string