HorizontalPodAutoscaler [autoscaling/v2]

Description

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

Type

`object`

Specification

Property	Type	Description
`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`	`ObjectMeta`	metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.
`status`	`object`	HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

.spec

Description

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Type

`object`

Required

scaleTargetRef
maxReplicas

Property	Type	Description
`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.

.spec.behavior

Description

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

Type

`object`

Property	Type	Description
`scaleDown`	`object`	HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance. Scaling Policy 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. The tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires the beta HPAConfigurableTolerance feature gate to be enabled.)
`scaleUp`	`object`	HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance. Scaling Policy 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. The tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires the beta HPAConfigurableTolerance feature gate to be enabled.)

.spec.behavior.scaleDown

Description

HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance.

Scaling Policy 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.

The tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires the beta HPAConfigurableTolerance feature gate to be enabled.)

Type

`object`

Property	Type	Description
`policies`	`array`	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.
`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).
`tolerance`	`Quantity`	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.

.spec.behavior.scaleDown.policies

Description

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.

Type

`array`

.spec.behavior.scaleDown.policies[]

Description

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

Type

`object`

Required

type
value
periodSeconds

Property	Type	Description
`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

.spec.behavior.scaleUp

Description

HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance.

Type

`object`

Property	Type	Description
`policies`	`array`	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.
`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).
`tolerance`	`Quantity`	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.

.spec.behavior.scaleUp.policies

Description

Type

`array`

.spec.behavior.scaleUp.policies[]

Description

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

Type

`object`

Required

type
value
periodSeconds

Property	Type	Description
`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

.spec.metrics

Description

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.

Type

`array`

.spec.metrics[]

Description

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

Type

`object`

Required

type

Property	Type	Description
`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.

.spec.metrics[].containerResource

Description

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.

Type

`object`

Required

name
target
container

Property	Type	Description
`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

.spec.metrics[].containerResource.target

Description

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

Type

`object`

Required

type

Property	Type	Description
`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).

.spec.metrics[].external

Description

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

Type

`object`

Required

metric
target

Property	Type	Description
`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

.spec.metrics[].external.metric

Description

MetricIdentifier defines the name and optionally selector for a metric

Type

`object`

Required

name

Property	Type	Description
`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.

.spec.metrics[].external.target

Description

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

Type

`object`

Required

type

Property	Type	Description
`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).

.spec.metrics[].object

Description

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

Type

`object`

Required

describedObject
target
metric

Property	Type	Description
`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

.spec.metrics[].object.describedObject

Description

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

Type

`object`

Required

kind
name

Property	Type	Description
`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

.spec.metrics[].object.metric

Description

MetricIdentifier defines the name and optionally selector for a metric

Type

`object`

Required

name

Property	Type	Description
`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.

.spec.metrics[].object.target

Description

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

Type

`object`

Required

type

Property	Type	Description
`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).

.spec.metrics[].pods

Description

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.

Type

`object`

Required

metric
target

Property	Type	Description
`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

.spec.metrics[].pods.metric

Description

MetricIdentifier defines the name and optionally selector for a metric

Type

`object`

Required

name

Property	Type	Description
`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.

.spec.metrics[].pods.target

Description

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

Type

`object`

Required

type

Property	Type	Description
`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).

.spec.metrics[].resource

Description

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

`object`

Required

name
target

Property	Type	Description
`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

.spec.metrics[].resource.target

Description

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

Type

`object`

Required

type

Property	Type	Description
`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).

.spec.scaleTargetRef

Description

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

Type

`object`

Required

kind
name

Property	Type	Description
`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

.status

Description

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

Type

`object`

Required

desiredReplicas

Property	Type	Description
`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.

.status.conditions

Description

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

Type

`array`

.status.conditions[]

Description

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

Type

`object`

Required

type
status

Property	Type	Description
`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

.status.currentMetrics

Description

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

Type

`array`

.status.currentMetrics[]

Description

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

Type

`object`

Required

type

Property	Type	Description
`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.

.status.currentMetrics[].containerResource

Description

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.

Type

`object`

Required

name
current
container

Property	Type	Description
`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.

.status.currentMetrics[].containerResource.current

Description

MetricValueStatus holds the current value for a metric

Type

`object`

Property	Type	Description
`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).

.status.currentMetrics[].external

Description

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

Type

`object`

Required

metric
current

Property	Type	Description
`current`	`object`	MetricValueStatus holds the current value for a metric
`metric`	`object`	MetricIdentifier defines the name and optionally selector for a metric

.status.currentMetrics[].external.current

Description

MetricValueStatus holds the current value for a metric

Type

`object`

Property	Type	Description
`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).

.status.currentMetrics[].external.metric

Description

MetricIdentifier defines the name and optionally selector for a metric

Type

`object`

Required

name

Property	Type	Description
`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.

.status.currentMetrics[].object

Description

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

Type

`object`

Required

metric
current
describedObject

Property	Type	Description
`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

.status.currentMetrics[].object.current

Description

MetricValueStatus holds the current value for a metric

Type

`object`

Property	Type	Description
`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).

.status.currentMetrics[].object.describedObject

Description

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

Type

`object`

Required

kind
name

Property	Type	Description
`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

.status.currentMetrics[].object.metric

Description

MetricIdentifier defines the name and optionally selector for a metric

Type

`object`

Required

name

Property	Type	Description
`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.

.status.currentMetrics[].pods

Description

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

Type

`object`

Required

metric
current

Property	Type	Description
`current`	`object`	MetricValueStatus holds the current value for a metric
`metric`	`object`	MetricIdentifier defines the name and optionally selector for a metric

.status.currentMetrics[].pods.current

Description

MetricValueStatus holds the current value for a metric

Type

`object`

Property	Type	Description
`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).

.status.currentMetrics[].pods.metric

Description

MetricIdentifier defines the name and optionally selector for a metric

Type

`object`

Required

name

Property	Type	Description
`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.

.status.currentMetrics[].resource

Description

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

`object`

Required

name
current

Property	Type	Description
`current`	`object`	MetricValueStatus holds the current value for a metric
`name`	`string`	name is the name of the resource in question.

.status.currentMetrics[].resource.current

Description

MetricValueStatus holds the current value for a metric

Type

`object`

Property	Type	Description
`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).

API endpoints

The following API endpoints are available:

/apis/autoscaling/v2/horizontalpodautoscalers
- GET: list or watch objects of kind HorizontalPodAutoscaler
/apis/autoscaling/v2/watch/horizontalpodautoscalers
- GET: watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
- DELETE: delete collection of HorizontalPodAutoscaler
- GET: list or watch objects of kind HorizontalPodAutoscaler
- POST: create a HorizontalPodAutoscaler
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers
- GET: watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
- DELETE: delete a HorizontalPodAutoscaler
- GET: read the specified HorizontalPodAutoscaler
- PATCH: partially update the specified HorizontalPodAutoscaler
- PUT: replace the specified HorizontalPodAutoscaler
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
- GET: watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
- GET: read status of the specified HorizontalPodAutoscaler
- PATCH: partially update status of the specified HorizontalPodAutoscaler
- PUT: replace status of the specified HorizontalPodAutoscaler

/apis/autoscaling/v2/horizontalpodautoscalers

HTTP method

`GET`

Description

list or watch objects of kind HorizontalPodAutoscaler

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscalerList` schema
401 - Unauthorized	Empty

/apis/autoscaling/v2/watch/horizontalpodautoscalers

HTTP method

`GET`

Description

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.

HTTP responses

HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers

HTTP method

`DELETE`

Description

delete collection of HorizontalPodAutoscaler

Query parameters

Parameter	Type	Description
`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

HTTP responses

HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list or watch objects of kind HorizontalPodAutoscaler

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscalerList` schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a HorizontalPodAutoscaler

Query parameters

Parameter	Type	Description
`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 parameters

Parameter	Type	Description
`body`	`HorizontalPodAutoscaler` schema

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
202 - Accepted	`HorizontalPodAutoscaler` schema
401 - Unauthorized	Empty

/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers

HTTP method

`GET`

Description

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.

HTTP responses

HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}

Global path parameters

Parameter	Type	Description
`name`	`string`	name of the HorizontalPodAutoscaler

HTTP method

`DELETE`

Description

delete a HorizontalPodAutoscaler

Query parameters

Parameter	Type	Description
`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

HTTP responses

HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified HorizontalPodAutoscaler

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscaler` schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified HorizontalPodAutoscaler

Query parameters

Parameter	Type	Description
`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.

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified HorizontalPodAutoscaler

Query parameters

Parameter	Type	Description
`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 parameters

Parameter	Type	Description
`body`	`HorizontalPodAutoscaler` schema

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
401 - Unauthorized	Empty

/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}

Global path parameters

Parameter	Type	Description
`name`	`string`	name of the HorizontalPodAutoscaler

HTTP method

`GET`

Description

watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead, filtered to a single item with the &#x27;fieldSelector&#x27; parameter.

HTTP responses

HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Global path parameters

Parameter	Type	Description
`name`	`string`	name of the HorizontalPodAutoscaler

HTTP method

`GET`

Description

read status of the specified HorizontalPodAutoscaler

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscaler` schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified HorizontalPodAutoscaler

Query parameters

Parameter	Type	Description
`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.

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified HorizontalPodAutoscaler

Query parameters

Parameter	Type	Description
`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 parameters

Parameter	Type	Description
`body`	`HorizontalPodAutoscaler` schema

HTTP responses

HTTP code	Reponse body
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
401 - Unauthorized	Empty

HorizontalPodAutoscaler [autoscaling/v2]¶

Specification¶

.spec¶

.spec.behavior¶

.spec.behavior.scaleDown¶

.spec.behavior.scaleDown.policies¶

.spec.behavior.scaleDown.policies[]¶

.spec.behavior.scaleUp¶

.spec.behavior.scaleUp.policies¶

.spec.behavior.scaleUp.policies[]¶

.spec.metrics¶

.spec.metrics[]¶

.spec.metrics[].containerResource¶

.spec.metrics[].containerResource.target¶

.spec.metrics[].external¶

.spec.metrics[].external.metric¶

.spec.metrics[].external.target¶

.spec.metrics[].object¶

.spec.metrics[].object.describedObject¶

.spec.metrics[].object.metric¶

.spec.metrics[].object.target¶

.spec.metrics[].pods¶

.spec.metrics[].pods.metric¶

.spec.metrics[].pods.target¶

.spec.metrics[].resource¶

.spec.metrics[].resource.target¶

.spec.scaleTargetRef¶

.status¶

.status.conditions¶

.status.conditions[]¶

.status.currentMetrics¶

.status.currentMetrics[]¶

.status.currentMetrics[].containerResource¶

.status.currentMetrics[].containerResource.current¶

.status.currentMetrics[].external¶

.status.currentMetrics[].external.current¶

.status.currentMetrics[].external.metric¶

.status.currentMetrics[].object¶

.status.currentMetrics[].object.current¶

.status.currentMetrics[].object.describedObject¶

.status.currentMetrics[].object.metric¶

.status.currentMetrics[].pods¶

.status.currentMetrics[].pods.current¶

.status.currentMetrics[].pods.metric¶

.status.currentMetrics[].resource¶

.status.currentMetrics[].resource.current¶

API endpoints¶

/apis/autoscaling/v2/horizontalpodautoscalers¶

/apis/autoscaling/v2/watch/horizontalpodautoscalers¶

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers¶

/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers¶

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}¶

/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}¶

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status¶

HorizontalPodAutoscaler [autoscaling/v2]

Specification

.spec

.spec.behavior

.spec.behavior.scaleDown

.spec.behavior.scaleDown.policies

.spec.behavior.scaleDown.policies[]

.spec.behavior.scaleUp

.spec.behavior.scaleUp.policies

.spec.behavior.scaleUp.policies[]

.spec.metrics

.spec.metrics[]

.spec.metrics[].containerResource

.spec.metrics[].containerResource.target

.spec.metrics[].external

.spec.metrics[].external.metric

.spec.metrics[].external.target

.spec.metrics[].object

.spec.metrics[].object.describedObject

.spec.metrics[].object.metric

.spec.metrics[].object.target

.spec.metrics[].pods

.spec.metrics[].pods.metric

.spec.metrics[].pods.target

.spec.metrics[].resource

.spec.metrics[].resource.target

.spec.scaleTargetRef

.status

.status.conditions

.status.conditions[]

.status.currentMetrics

.status.currentMetrics[]

.status.currentMetrics[].containerResource

.status.currentMetrics[].containerResource.current

.status.currentMetrics[].external

.status.currentMetrics[].external.current

.status.currentMetrics[].external.metric

.status.currentMetrics[].object

.status.currentMetrics[].object.current

.status.currentMetrics[].object.describedObject

.status.currentMetrics[].object.metric

.status.currentMetrics[].pods

.status.currentMetrics[].pods.current

.status.currentMetrics[].pods.metric

.status.currentMetrics[].resource

.status.currentMetrics[].resource.current

API endpoints

/apis/autoscaling/v2/horizontalpodautoscalers

/apis/autoscaling/v2/watch/horizontalpodautoscalers

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers

/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}

/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}

/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status