MetricSpec

data class MetricSpec(val containerResource: ContainerResourceMetricSource? = null, val external: ExternalMetricSource? = null, val object: ObjectMetricSource? = null, val pods: PodsMetricSource? = null, val resource: ResourceMetricSource? = null, val type: String)

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

Constructors

Link copied to clipboard
constructor(containerResource: ContainerResourceMetricSource? = null, external: ExternalMetricSource? = null, object: ObjectMetricSource? = null, pods: PodsMetricSource? = null, resource: ResourceMetricSource? = null, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val pods: PodsMetricSource? = null

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.

Link copied to clipboard

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.

Link copied to clipboard

type is the type of metric source. It should be one of "Object", "Pods" or "Resource", each mapping to a matching field in the object.