Search

Chapter 4. HorizontalPodAutoscaler [autoscaling/v2]

download PDF
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

4.1. Specification

PropertyTypeDescription

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.

4.1.1. .spec

Description
HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.
Type
object
Required
  • scaleTargetRef
  • maxReplicas
PropertyTypeDescription

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.

4.1.2. .spec.behavior

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

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.

4.1.3. .spec.behavior.scaleDown

Description
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.
Type
object
PropertyTypeDescription

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

4.1.4. .spec.behavior.scaleDown.policies

Description
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
Type
array

4.1.5. .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
PropertyTypeDescription

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

4.1.6. .spec.behavior.scaleUp

Description
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.
Type
object
PropertyTypeDescription

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

4.1.7. .spec.behavior.scaleUp.policies

Description
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
Type
array

4.1.8. .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
PropertyTypeDescription

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

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

4.1.10. .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
PropertyTypeDescription

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

4.1.11. .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
PropertyTypeDescription

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

4.1.12. .spec.metrics[].containerResource.target

Description
MetricTarget defines the target value, average value, or average utilization of a specific metric
Type
object
Required
  • type
PropertyTypeDescription

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

4.1.13. .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
PropertyTypeDescription

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

4.1.14. .spec.metrics[].external.metric

Description
MetricIdentifier defines the name and optionally selector for a metric
Type
object
Required
  • name
PropertyTypeDescription

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.

4.1.15. .spec.metrics[].external.target

Description
MetricTarget defines the target value, average value, or average utilization of a specific metric
Type
object
Required
  • type
PropertyTypeDescription

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

4.1.16. .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
PropertyTypeDescription

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

4.1.17. .spec.metrics[].object.describedObject

Description
CrossVersionObjectReference contains enough information to let you identify the referred resource.
Type
object
Required
  • kind
  • name
PropertyTypeDescription

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

4.1.18. .spec.metrics[].object.metric

Description
MetricIdentifier defines the name and optionally selector for a metric
Type
object
Required
  • name
PropertyTypeDescription

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.

4.1.19. .spec.metrics[].object.target

Description
MetricTarget defines the target value, average value, or average utilization of a specific metric
Type
object
Required
  • type
PropertyTypeDescription

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

4.1.20. .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
PropertyTypeDescription

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

4.1.21. .spec.metrics[].pods.metric

Description
MetricIdentifier defines the name and optionally selector for a metric
Type
object
Required
  • name
PropertyTypeDescription

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.

4.1.22. .spec.metrics[].pods.target

Description
MetricTarget defines the target value, average value, or average utilization of a specific metric
Type
object
Required
  • type
PropertyTypeDescription

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

4.1.23. .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
PropertyTypeDescription

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

4.1.24. .spec.metrics[].resource.target

Description
MetricTarget defines the target value, average value, or average utilization of a specific metric
Type
object
Required
  • type
PropertyTypeDescription

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

4.1.25. .spec.scaleTargetRef

Description
CrossVersionObjectReference contains enough information to let you identify the referred resource.
Type
object
Required
  • kind
  • name
PropertyTypeDescription

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

4.1.26. .status

Description
HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.
Type
object
Required
  • desiredReplicas
PropertyTypeDescription

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.

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

4.1.28. .status.conditions[]

Description
HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.
Type
object
Required
  • type
  • status
PropertyTypeDescription

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

4.1.29. .status.currentMetrics

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

4.1.30. .status.currentMetrics[]

Description
MetricStatus describes the last-read state of a single metric.
Type
object
Required
  • type
PropertyTypeDescription

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

4.1.31. .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
PropertyTypeDescription

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.

4.1.32. .status.currentMetrics[].containerResource.current

Description
MetricValueStatus holds the current value for a metric
Type
object
PropertyTypeDescription

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

4.1.33. .status.currentMetrics[].external

Description
ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.
Type
object
Required
  • metric
  • current
PropertyTypeDescription

current

object

MetricValueStatus holds the current value for a metric

metric

object

MetricIdentifier defines the name and optionally selector for a metric

4.1.34. .status.currentMetrics[].external.current

Description
MetricValueStatus holds the current value for a metric
Type
object
PropertyTypeDescription

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

4.1.35. .status.currentMetrics[].external.metric

Description
MetricIdentifier defines the name and optionally selector for a metric
Type
object
Required
  • name
PropertyTypeDescription

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.

4.1.36. .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
PropertyTypeDescription

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

4.1.37. .status.currentMetrics[].object.current

Description
MetricValueStatus holds the current value for a metric
Type
object
PropertyTypeDescription

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

4.1.38. .status.currentMetrics[].object.describedObject

Description
CrossVersionObjectReference contains enough information to let you identify the referred resource.
Type
object
Required
  • kind
  • name
PropertyTypeDescription

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

4.1.39. .status.currentMetrics[].object.metric

Description
MetricIdentifier defines the name and optionally selector for a metric
Type
object
Required
  • name
PropertyTypeDescription

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.

4.1.40. .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
PropertyTypeDescription

current

object

MetricValueStatus holds the current value for a metric

metric

object

MetricIdentifier defines the name and optionally selector for a metric

4.1.41. .status.currentMetrics[].pods.current

Description
MetricValueStatus holds the current value for a metric
Type
object
PropertyTypeDescription

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

4.1.42. .status.currentMetrics[].pods.metric

Description
MetricIdentifier defines the name and optionally selector for a metric
Type
object
Required
  • name
PropertyTypeDescription

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.

4.1.43. .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
PropertyTypeDescription

current

object

MetricValueStatus holds the current value for a metric

name

string

name is the name of the resource in question.

4.1.44. .status.currentMetrics[].resource.current

Description
MetricValueStatus holds the current value for a metric
Type
object
PropertyTypeDescription

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

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

4.2.1. /apis/autoscaling/v2/horizontalpodautoscalers

HTTP method
GET
Description
list or watch objects of kind HorizontalPodAutoscaler
Table 4.1. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscalerList schema

401 - Unauthorized

Empty

4.2.2. /apis/autoscaling/v2/watch/horizontalpodautoscalers

HTTP method
GET
Description
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
Table 4.2. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

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

HTTP method
DELETE
Description
delete collection of HorizontalPodAutoscaler
Table 4.3. Query parameters
ParameterTypeDescription

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

Table 4.4. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind HorizontalPodAutoscaler
Table 4.5. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscalerList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a HorizontalPodAutoscaler
Table 4.6. Query parameters
ParameterTypeDescription

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.

Table 4.7. Body parameters
ParameterTypeDescription

body

HorizontalPodAutoscaler schema

 
Table 4.8. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

202 - Accepted

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

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

HTTP method
GET
Description
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
Table 4.9. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

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

Table 4.10. Global path parameters
ParameterTypeDescription

name

string

name of the HorizontalPodAutoscaler

HTTP method
DELETE
Description
delete a HorizontalPodAutoscaler
Table 4.11. Query parameters
ParameterTypeDescription

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

Table 4.12. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified HorizontalPodAutoscaler
Table 4.13. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified HorizontalPodAutoscaler
Table 4.14. Query parameters
ParameterTypeDescription

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.

Table 4.15. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified HorizontalPodAutoscaler
Table 4.16. Query parameters
ParameterTypeDescription

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.

Table 4.17. Body parameters
ParameterTypeDescription

body

HorizontalPodAutoscaler schema

 
Table 4.18. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

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

Table 4.19. Global path parameters
ParameterTypeDescription

name

string

name of the HorizontalPodAutoscaler

HTTP method
GET
Description
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.
Table 4.20. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

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

Table 4.21. Global path parameters
ParameterTypeDescription

name

string

name of the HorizontalPodAutoscaler

HTTP method
GET
Description
read status of the specified HorizontalPodAutoscaler
Table 4.22. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified HorizontalPodAutoscaler
Table 4.23. Query parameters
ParameterTypeDescription

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.

Table 4.24. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified HorizontalPodAutoscaler
Table 4.25. Query parameters
ParameterTypeDescription

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.

Table 4.26. Body parameters
ParameterTypeDescription

body

HorizontalPodAutoscaler schema

 
Table 4.27. HTTP responses
HTTP codeReponse body

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.