Chapter 4. HorizontalPodAutoscaler [autoscaling/v2]

behavior

object

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

maxReplicas

integer

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.

metrics

array

metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.

metrics[]

object

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).

minReplicas

integer

minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.

scaleTargetRef

object

CrossVersionObjectReference contains enough information to let you identify the referred resource.

scaleDown

object

HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.

scaleUp

object

HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.

policies

array

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

policies[]

object

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

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).

periodSeconds

integer

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

string

type is used to specify the scaling policy.

value

integer

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

policies

array

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

policies[]

object

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

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).

periodSeconds

integer

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

string

type is used to specify the scaling policy.

value

integer

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

containerResource

object

ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

external

object

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

object

object

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

pods

object

PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

resource

object

ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

type

string

type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled

container

string

container is the name of the container in the pods of the scaling target

name

string

name is the name of the resource in question.

target

object

MetricTarget defines the target value, average value, or average utilization of a specific metric

averageUtilization

integer

averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type

averageValue

Quantity

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

type

string

type represents whether the metric type is Utilization, Value, or AverageValue

value

Quantity

value is the target value of the metric (as a quantity).

metric

object

MetricIdentifier defines the name and optionally selector for a metric

target

object

MetricTarget defines the target value, average value, or average utilization of a specific metric

name

string

name is the name of the given metric

selector

LabelSelector

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

averageUtilization

integer

averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type

averageValue

Quantity

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

type

string

type represents whether the metric type is Utilization, Value, or AverageValue

value

Quantity

value is the target value of the metric (as a quantity).

describedObject

object

CrossVersionObjectReference contains enough information to let you identify the referred resource.

metric

object

MetricIdentifier defines the name and optionally selector for a metric

target

object

MetricTarget defines the target value, average value, or average utilization of a specific metric

apiVersion

string

apiVersion is the API version of the referent

kind

string

kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

name

string

name is the name of the given metric

selector

LabelSelector

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

averageUtilization

integer

averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type

averageValue

Quantity

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

type

string

type represents whether the metric type is Utilization, Value, or AverageValue

value

Quantity

value is the target value of the metric (as a quantity).

metric

object

MetricIdentifier defines the name and optionally selector for a metric

target

object

MetricTarget defines the target value, average value, or average utilization of a specific metric

name

string

name is the name of the given metric

selector

LabelSelector

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

averageUtilization

integer

averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type

averageValue

Quantity

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

type

string

type represents whether the metric type is Utilization, Value, or AverageValue

value

Quantity

value is the target value of the metric (as a quantity).

name

string

name is the name of the resource in question.

target

object

MetricTarget defines the target value, average value, or average utilization of a specific metric

averageUtilization

integer

averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type

averageValue

Quantity

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

type

string

type represents whether the metric type is Utilization, Value, or AverageValue

value

Quantity

value is the target value of the metric (as a quantity).

apiVersion

string

apiVersion is the API version of the referent

kind

string

kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

conditions

array

conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.

conditions[]

object

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

currentMetrics

array

currentMetrics is the last read state of the metrics used by this autoscaler.

currentMetrics[]

object

MetricStatus describes the last-read state of a single metric.

currentReplicas

integer

currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.

desiredReplicas

integer

desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.

lastScaleTime

Time

lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.

observedGeneration

integer

observedGeneration is the most recent generation observed by this autoscaler.

lastTransitionTime

Time

lastTransitionTime is the last time the condition transitioned from one status to another

message

string

message is a human-readable explanation containing details about the transition

reason

string

reason is the reason for the condition’s last transition.

status

string

status is the status of the condition (True, False, Unknown)

type

string

type describes the current condition

containerResource

object

ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

external

object

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

object

object

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

pods

object

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

resource

object

ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

type

string

type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled

container

string

container is the name of the container in the pods of the scaling target

current

object

MetricValueStatus holds the current value for a metric

name

string

name is the name of the resource in question.

averageUtilization

integer

currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.

averageValue

Quantity

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

value

Quantity

value is the current value of the metric (as a quantity).

current

object

MetricValueStatus holds the current value for a metric

metric

object

MetricIdentifier defines the name and optionally selector for a metric

averageUtilization

integer

currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.

averageValue

Quantity

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

value

Quantity

value is the current value of the metric (as a quantity).

name

string

name is the name of the given metric

selector

LabelSelector

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

current

object

MetricValueStatus holds the current value for a metric

describedObject

object

CrossVersionObjectReference contains enough information to let you identify the referred resource.

metric

object

MetricIdentifier defines the name and optionally selector for a metric

averageUtilization

integer

currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.

averageValue

Quantity

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

value

Quantity

value is the current value of the metric (as a quantity).

apiVersion

string

apiVersion is the API version of the referent

kind

string

kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

name

string

name is the name of the given metric

selector

LabelSelector

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

current

object

MetricValueStatus holds the current value for a metric

metric

object

MetricIdentifier defines the name and optionally selector for a metric

averageUtilization

integer

currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.

averageValue

Quantity

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

value

Quantity

value is the current value of the metric (as a quantity).

name

string

name is the name of the given metric

selector

LabelSelector

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

current

object

MetricValueStatus holds the current value for a metric

name

string

name is the name of the resource in question.

averageUtilization

integer

currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.

averageValue

Quantity

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

value

Quantity

value is the current value of the metric (as a quantity).

200 - OK

HorizontalPodAutoscalerList schema

401 - Unauthorized

Empty

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

200 - OK

Status schema

401 - Unauthorized

Empty

200 - OK

HorizontalPodAutoscalerList schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

HorizontalPodAutoscaler schema

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

202 - Accepted

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

name

string

name of the HorizontalPodAutoscaler

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

200 - OK

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

HorizontalPodAutoscaler schema

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

name

string

name of the HorizontalPodAutoscaler

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

name

string

name of the HorizontalPodAutoscaler

200 - OK

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

HorizontalPodAutoscaler schema

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty