- 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
- Specification
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 defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. |
|
| 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 |
---|---|---|
|
| HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). |
|
| maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. |
|
| 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. |
|
| MetricSpec specifies how to scale based on a single metric (only |
|
| 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. |
|
| 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 |
---|---|---|
|
| 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. |
|
| 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. |
.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
Property | Type | 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 |
|
| HPAScalingPolicy is a single policy which must hold true for a specified past interval. |
|
| selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. |
|
| stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). |
.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
.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 specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). |
|
| type is used to specify the scaling policy. |
|
| value contains the amount of change which is permitted by the policy. It must be greater than zero |
.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
Property | Type | 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 |
|
| HPAScalingPolicy is a single policy which must hold true for a specified past interval. |
|
| selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. |
|
| stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). |
.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
.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 specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). |
|
| type is used to specify the scaling policy. |
|
| value contains the amount of change which is permitted by the policy. It must be greater than zero |
.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 |
---|---|---|
|
| 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. |
|
| 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). |
|
| ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress 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. |
|
| 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 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 |
.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 is the name of the container in the pods of the scaling target |
|
| name is the name of the resource in question. |
|
| 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 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 is the target value of the average of the metric across all relevant pods (as a quantity) | |
|
| type represents whether the metric type is Utilization, Value, or AverageValue |
| 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 |
---|---|---|
|
| MetricIdentifier defines the name and optionally selector for a metric |
|
| 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 is the name of the given metric |
| 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 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 is the target value of the average of the metric across all relevant pods (as a quantity) | |
|
| type represents whether the metric type is Utilization, Value, or AverageValue |
| 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 |
---|---|---|
|
| CrossVersionObjectReference contains enough information to let you identify the referred resource. |
|
| MetricIdentifier defines the name and optionally selector for a metric |
|
| 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 is the API version of the referent |
|
| kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 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 is the name of the given metric |
| 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 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 is the target value of the average of the metric across all relevant pods (as a quantity) | |
|
| type represents whether the metric type is Utilization, Value, or AverageValue |
| 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 |
---|---|---|
|
| MetricIdentifier defines the name and optionally selector for a metric |
|
| 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 is the name of the given metric |
| 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 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 is the target value of the average of the metric across all relevant pods (as a quantity) | |
|
| type represents whether the metric type is Utilization, Value, or AverageValue |
| 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 is the name of the resource in question. |
|
| 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 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 is the target value of the average of the metric across all relevant pods (as a quantity) | |
|
| type represents whether the metric type is Utilization, Value, or AverageValue |
| 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 is the API version of the referent |
|
| kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 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 is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. |
|
| HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point. |
|
| currentMetrics is the last read state of the metrics used by this autoscaler. |
|
| MetricStatus describes the last-read state of a single metric. |
|
| currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. |
|
| desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. |
| 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 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 is the last time the condition transitioned from one status to another | |
|
| message is a human-readable explanation containing details about the transition |
|
| reason is the reason for the condition’s last transition. |
|
| status is the status of the condition (True, False, Unknown) |
|
| 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 |
---|---|---|
|
| 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. |
|
| ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object. |
|
| ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). |
|
| PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second). |
|
| 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 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 |
.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 is the name of the container in the pods of the scaling target |
|
| MetricValueStatus holds the current value for a metric |
|
| 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 |
---|---|---|
|
| 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 is the current value of the average of the metric across all relevant pods (as a 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 |
---|---|---|
|
| MetricValueStatus holds the current value for a metric |
|
| 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 |
---|---|---|
|
| 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 is the current value of the average of the metric across all relevant pods (as a 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 is the name of the given metric |
| 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 |
---|---|---|
|
| MetricValueStatus holds the current value for a metric |
|
| CrossVersionObjectReference contains enough information to let you identify the referred resource. |
|
| 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 |
---|---|---|
|
| 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 is the current value of the average of the metric across all relevant pods (as a 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 is the API version of the referent |
|
| kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 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 is the name of the given metric |
| 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 |
---|---|---|
|
| MetricValueStatus holds the current value for a metric |
|
| 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 |
---|---|---|
|
| 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 is the current value of the average of the metric across all relevant pods (as a 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 is the name of the given metric |
| 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 |
---|---|---|
|
| MetricValueStatus holds the current value for a metric |
|
| 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 |
---|---|---|
|
| 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 is the current value of the average of the metric across all relevant pods (as a 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 HorizontalPodAutoscalerGET
: list or watch objects of kind HorizontalPodAutoscalerPOST
: 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 HorizontalPodAutoscalerGET
: read the specified HorizontalPodAutoscalerPATCH
: partially update the specified HorizontalPodAutoscalerPUT
: 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 HorizontalPodAutoscalerPATCH
: partially update status of the specified HorizontalPodAutoscalerPUT
: replace status of the specified HorizontalPodAutoscaler
/apis/autoscaling/v2/horizontalpodautoscalers
HTTP method
GET
Description
list or watch objects of kind HorizontalPodAutoscaler
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 ‘watch’ parameter with a list operation instead.
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
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list or watch objects of kind HorizontalPodAutoscaler
HTTP code | Reponse body |
---|---|
200 - OK | HorizontalPodAutoscalerList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a HorizontalPodAutoscaler
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| HorizontalPodAutoscaler schema |
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 ‘watch’ parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK | WatchEvent schema |
401 - Unauthorized | Empty |
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the HorizontalPodAutoscaler |
HTTP method
DELETE
Description
delete a HorizontalPodAutoscaler
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified HorizontalPodAutoscaler
HTTP code | Reponse body |
---|---|
200 - OK | HorizontalPodAutoscaler schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified HorizontalPodAutoscaler
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK | HorizontalPodAutoscaler schema |
201 - Created | HorizontalPodAutoscaler schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified HorizontalPodAutoscaler
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| HorizontalPodAutoscaler schema |
HTTP code | Reponse body |
---|---|
200 - OK | HorizontalPodAutoscaler schema |
201 - Created | HorizontalPodAutoscaler schema |
401 - Unauthorized | Empty |
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | Type | Description |
---|---|---|
|
| 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.
HTTP code | Reponse body |
---|---|
200 - OK | WatchEvent schema |
401 - Unauthorized | Empty |
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the HorizontalPodAutoscaler |
HTTP method
GET
Description
read status of the specified HorizontalPodAutoscaler
HTTP code | Reponse body |
---|---|
200 - OK | HorizontalPodAutoscaler schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified HorizontalPodAutoscaler
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK | HorizontalPodAutoscaler schema |
201 - Created | HorizontalPodAutoscaler schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified HorizontalPodAutoscaler
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| HorizontalPodAutoscaler schema |
HTTP code | Reponse body |
---|---|
200 - OK | HorizontalPodAutoscaler schema |
201 - Created | HorizontalPodAutoscaler schema |
401 - Unauthorized | Empty |