Kind
Scaledobject
Group
keda.sh
Version
v1alpha1
apiVersion: keda.sh/v1alpha1 kind: Scaledobject metadata: name: example
View raw schema
apiVersion string
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 string
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
metadata object
spec object required
ScaledObjectSpec is the spec for a ScaledObject resource
advanced object
AdvancedConfig specifies advance scaling options
horizontalPodAutoscalerConfig object
HorizontalPodAutoscalerConfig specifies horizontal scale config
behavior object
HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).
scaleDown object
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 []object
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 integer required
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).
format: int32
type string required
type is used to specify the scaling policy.
value integer required
value contains the amount of change which is permitted by the policy. It must be greater than zero
format: int32
selectPolicy string
selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
stabilizationWindowSeconds integer
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).
format: int32
minimum: 0
maximum: 3600
tolerance object
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 alpha field and requires enabling the HPAConfigurableTolerance feature gate.
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
scaleUp object
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 []object
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 integer required
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).
format: int32
type string required
type is used to specify the scaling policy.
value integer required
value contains the amount of change which is permitted by the policy. It must be greater than zero
format: int32
selectPolicy string
selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
stabilizationWindowSeconds integer
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).
format: int32
minimum: 0
maximum: 3600
tolerance object
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 alpha field and requires enabling the HPAConfigurableTolerance feature gate.
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
name string
restoreToOriginalReplicaCount boolean
scalingModifiers object
ScalingModifiers describes advanced scaling logic options like formula
activationTarget string
formula string
metricType string
MetricTargetType specifies the type of metric being targeted, and should be either "Value", "AverageValue", or "Utilization"
enum: AverageValue, Value
target string
cooldownPeriod integer
format: int32
fallback object
Fallback is the spec for fallback options
behavior string
enum: static, currentReplicas, currentReplicasIfHigher, currentReplicasIfLower
failureThreshold integer required
format: int32
replicas integer required
format: int32
idleReplicaCount integer
format: int32
initialCooldownPeriod integer
format: int32
maxReplicaCount integer
format: int32
minReplicaCount integer
format: int32
pollingInterval integer
format: int32
scaleTargetRef object required
ScaleTarget holds the reference to the scale target Object
apiVersion string
envSourceContainerName string
kind string
name string required
triggers []object required
authenticationRef object
AuthenticationRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that is used to authenticate the scaler with the environment
kind string
Kind of the resource being referred to. Defaults to TriggerAuthentication.
name string required
metadata object required
metricType string
MetricTargetType specifies the type of metric being targeted, and should be either "Value", "AverageValue", or "Utilization"
name string
type string required
useCachedMetrics boolean
status object
ScaledObjectStatus is the status for a ScaledObject resource
authenticationsTypes string
compositeScalerName string
conditions []object
Conditions an array representation to store multiple Conditions
message string
A human readable message indicating details about the transition.
reason string
The reason for the condition's last transition.
status string required
Status of the condition, one of True, False, Unknown.
type string required
Type of condition
externalMetricNames []string
health object
hpaName string
lastActiveTime string
format: date-time
originalReplicaCount integer
format: int32
pausedReplicaCount integer
format: int32
resourceMetricNames []string
scaleTargetGVKR object
GroupVersionKindResource provides unified structure for schema.GroupVersionKind and Resource
group string required
kind string required
resource string required
version string required
scaleTargetKind string
triggersActivity object
triggersTypes string
Copied!