ScaledObject is a specification for a ScaledObject resource
5 top-level fields, 1 required · last changed in Keda v2.20.0
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
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
ScaledObjectSpec is the spec for a ScaledObject resource
AdvancedConfig specifies advance scaling options
HorizontalPodAutoscalerConfig specifies horizontal scale config
HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).
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).
policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.
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).
type is used to specify the scaling policy.
value contains the amount of change which is permitted by the policy. It must be greater than zero
selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
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).
tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%). For example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi. This is an beta field and requires the HPAConfigurableTolerance feature gate to be enabled.
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.
policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.
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).
type is used to specify the scaling policy.
value contains the amount of change which is permitted by the policy. It must be greater than zero
selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
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).
tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%). For example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi. This is an beta field and requires the HPAConfigurableTolerance feature gate to be enabled.
ScalingModifiers describes advanced scaling logic options like formula
MetricTargetType specifies the type of metric being targeted, and should be either "Value", "AverageValue", or "Utilization"
Fallback is the spec for fallback options
ScaleTarget holds the reference to the scale target Object
AuthenticationRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that is used to authenticate the scaler with the environment
Kind of the resource being referred to. Defaults to TriggerAuthentication.
MetricTargetType specifies the type of metric being targeted, and should be either "Value", "AverageValue", or "Utilization"
ScaledObjectStatus is the status for a ScaledObject resource
Conditions an array representation to store multiple Conditions
A human readable message indicating details about the transition.
The reason for the condition's last transition.
Status of the condition, one of True, False, Unknown.
Type of condition
HealthStatusType is an indication of whether the health status is happy or failing
GroupVersionKindResource provides unified structure for schema.GroupVersionKind and Resource
Source: keda.sh_scaledobjects.yaml
Changes to ScaledObject (keda.sh/v1alpha1) in each Keda version, compared to the version before it.
2 properties have changed the description
Released · View ScaledObject in v2.20.0
1 property has been added
Released · View ScaledObject in v2.19.0
2 properties have been added
2 properties have changed the description
Released · View ScaledObject in v2.18.0
1 property has been added
Released · View ScaledObject in v2.17.0
2 properties have been added
Released · View ScaledObject in v2.16.0
1 property has been added
18 properties have changed the description
Released · View ScaledObject in v2.14.0
2 properties have been added
1 property has changed the description
Released · View ScaledObject in v2.12.0
9 properties have changed the description
Released · View ScaledObject in v2.11.0
1 property has been added
2 properties have changed the description
Released · View ScaledObject in v2.9.0
2 properties have been added
1 property has changed the description
Released · View ScaledObject in v2.8.0
4 properties have been added
Released · View ScaledObject in v2.4.0
1 property has been added
1 property has changed the description
Released · View ScaledObject in v2.1.0
ScaledObject was first seen on this version of Keda
Released · View ScaledObject in v2.0.0
No examples of ScaledObject yet. Contribute one on GitHub.
kubespec.dev