package k8s.io.api.autoscaling.v2

Get desktop application:
View/edit binary Protocol Buffers messages

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.

Used in: MetricSpec

• optional string name = 1

  name is the name of the resource in question.

• optional MetricTarget target = 2

  target specifies the target value for the given metric

• optional string container = 3

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

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.

Used in: MetricStatus

• optional string name = 1

  Name is the name of the resource in question.

• optional MetricValueStatus current = 2

  current contains the current value for the given metric

• optional string container = 3

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

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

Used in: HorizontalPodAutoscalerSpec, ObjectMetricSource, ObjectMetricStatus

• optional string kind = 1

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

• optional string name = 2

  Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

• optional string apiVersion = 3

  API version of the referent +optional

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

Used in: MetricSpec

• optional MetricIdentifier metric = 1

  metric identifies the target metric by name and selector

• optional MetricTarget target = 2

  target specifies the target value for the given metric

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

Used in: MetricStatus

• optional MetricIdentifier metric = 1

  metric identifies the target metric by name and selector

• optional MetricValueStatus current = 2

  current contains the current value for the given metric

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

Used in: HPAScalingRules

• optional string type = 1

  Type is used to specify the scaling policy.

• optional int32 value = 2

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

• optional int32 periodSeconds = 3

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

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.

Used in: HorizontalPodAutoscalerBehavior

• optional int32 stabilizationWindowSeconds = 3

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

• optional string selectPolicy = 1

  selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. +optional

• repeated HPAScalingPolicy policies = 2

  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 +listType=atomic +optional

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.

Used in: HorizontalPodAutoscalerList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional HorizontalPodAutoscalerSpec spec = 2

  spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. +optional

• optional HorizontalPodAutoscalerStatus status = 3

  status is the current information about the autoscaler. +optional

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

Used in: HorizontalPodAutoscalerSpec

• optional HPAScalingRules scaleUp = 1

  scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * increase no more than 4 pods per 60 seconds * double the number of pods per 60 seconds No stabilization is used. +optional

• optional HPAScalingRules scaleDown = 2

  scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). +optional

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

Used in: HorizontalPodAutoscalerStatus

• optional string type = 1

  type describes the current condition

• optional string status = 2

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

• optional apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3

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

• optional string reason = 4

  reason is the reason for the condition's last transition. +optional

• optional string message = 5

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

HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  metadata is the standard list metadata. +optional

• repeated HorizontalPodAutoscaler items = 2

  items is the list of horizontal pod autoscaler objects.

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Used in: HorizontalPodAutoscaler

• optional CrossVersionObjectReference scaleTargetRef = 1

  scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.

• optional int32 minReplicas = 2

  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. +optional

• optional int32 maxReplicas = 3

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

• repeated MetricSpec metrics = 4

  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. +listType=atomic +optional

• optional HorizontalPodAutoscalerBehavior behavior = 5

  behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used. +optional

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

Used in: HorizontalPodAutoscaler

• optional int64 observedGeneration = 1

  observedGeneration is the most recent generation observed by this autoscaler. +optional

• optional apimachinery.pkg.apis.meta.v1.Time lastScaleTime = 2

  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. +optional

• optional int32 currentReplicas = 3

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

• optional int32 desiredReplicas = 4

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

• repeated MetricStatus currentMetrics = 5

  currentMetrics is the last read state of the metrics used by this autoscaler. +listType=atomic +optional

• repeated HorizontalPodAutoscalerCondition conditions = 6

  conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type +optional

MetricIdentifier defines the name and optionally selector for a metric

Used in: ExternalMetricSource, ExternalMetricStatus, ObjectMetricSource, ObjectMetricStatus, PodsMetricSource, PodsMetricStatus

• optional string name = 1

  name is the name of the given metric

• optional apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2

  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. +optional

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

Used in: HorizontalPodAutoscalerSpec

• optional string type = 1

  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

• optional ObjectMetricSource object = 2

  object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). +optional

• optional PodsMetricSource pods = 3

  pods refers to 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. +optional

• optional ResourceMetricSource resource = 4

  resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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. +optional

• optional ContainerResourceMetricSource containerResource = 7

  containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of 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. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. +optional

• optional ExternalMetricSource external = 5

  external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). +optional

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

Used in: HorizontalPodAutoscalerStatus

• optional string type = 1

  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

• optional ObjectMetricStatus object = 2

  object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). +optional

• optional PodsMetricStatus pods = 3

  pods refers to 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. +optional

• optional ResourceMetricStatus resource = 4

  resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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. +optional

• optional ContainerResourceMetricStatus containerResource = 7

  container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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. +optional

• optional ExternalMetricStatus external = 5

  external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). +optional

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

Used in: ContainerResourceMetricSource, ExternalMetricSource, ObjectMetricSource, PodsMetricSource, ResourceMetricSource

• optional string type = 1

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

• optional apimachinery.pkg.api.resource.Quantity value = 2

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

• optional apimachinery.pkg.api.resource.Quantity averageValue = 3

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

• optional int32 averageUtilization = 4

  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 +optional

MetricValueStatus holds the current value for a metric

Used in: ContainerResourceMetricStatus, ExternalMetricStatus, ObjectMetricStatus, PodsMetricStatus, ResourceMetricStatus

• optional apimachinery.pkg.api.resource.Quantity value = 1

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

• optional apimachinery.pkg.api.resource.Quantity averageValue = 2

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

• optional int32 averageUtilization = 3

  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. +optional

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

Used in: MetricSpec

• optional CrossVersionObjectReference describedObject = 1

  describedObject specifies the descriptions of a object,such as kind,name apiVersion

• optional MetricTarget target = 2

  target specifies the target value for the given metric

• optional MetricIdentifier metric = 3

  metric identifies the target metric by name and selector

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

Used in: MetricStatus

• optional MetricIdentifier metric = 1

  metric identifies the target metric by name and selector

• optional MetricValueStatus current = 2

  current contains the current value for the given metric

• optional CrossVersionObjectReference describedObject = 3

  DescribedObject specifies the descriptions of a object,such as kind,name apiVersion

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.

Used in: MetricSpec

• optional MetricIdentifier metric = 1

  metric identifies the target metric by name and selector

• optional MetricTarget target = 2

  target specifies the target value for the given metric

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

Used in: MetricStatus

• optional MetricIdentifier metric = 1

  metric identifies the target metric by name and selector

• optional MetricValueStatus current = 2

  current contains the current value for the given metric

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.

Used in: MetricSpec

• optional string name = 1

  name is the name of the resource in question.

• optional MetricTarget target = 2

  target specifies the target value for the given metric

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.

Used in: MetricStatus

• optional string name = 1

  Name is the name of the resource in question.

• optional MetricValueStatus current = 2

  current contains the current value for the given metric