package k8s.io.api.autoscaling.v2beta1

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 int32 targetAverageUtilization = 2

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

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

  targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. +optional

• optional string container = 4

  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 int32 currentAverageUtilization = 2

  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. It will only be present if `targetAverageValue` was set in the corresponding metric specification. +optional

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

  currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification.

• optional string container = 4

  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). Exactly one "target" type should be set.

Used in: MetricSpec

• optional string metricName = 1

  metricName is the name of the metric in question.

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

  metricSelector is used to identify a specific time series within a given metric. +optional

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

  targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue. +optional

• optional apimachinery.pkg.api.resource.Quantity targetAverageValue = 4

  targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue. +optional

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

Used in: MetricStatus

• optional string metricName = 1

  metricName is the name of a metric used for autoscaling in metric system.

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

  metricSelector is used to identify a specific time series within a given metric. +optional

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

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

• optional apimachinery.pkg.api.resource.Quantity currentAverageValue = 4

  currentAverageValue is the current value of metric averaged over autoscaled pods. +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

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

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

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

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 target = 1

  target is the described Kubernetes object.

• optional string metricName = 2

  metricName is the name of the metric in question.

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

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

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

  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

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

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

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 CrossVersionObjectReference target = 1

  target is the described Kubernetes object.

• optional string metricName = 2

  metricName is the name of the metric in question.

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

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

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

  selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the ObjectMetricSource, 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

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

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

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 string metricName = 1

  metricName is the name of the metric in question

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

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

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

  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

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 string metricName = 1

  metricName is the name of the metric in question

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

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

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

  selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the PodsMetricSource, 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

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 int32 targetAverageUtilization = 2

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

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

  targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. +optional

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 int32 currentAverageUtilization = 2

  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. It will only be present if `targetAverageValue` was set in the corresponding metric specification. +optional

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

  currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification.