Struct k8s_openapi::api::autoscaling::v2::MetricSpec

pub struct MetricSpec {
    pub container_resource: Option<ContainerResourceMetricSource>,
    pub external: Option<ExternalMetricSource>,
    pub object: Option<ObjectMetricSource>,
    pub pods: Option<PodsMetricSource>,
    pub resource: Option<ResourceMetricSource>,
    pub type_: String,
}

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

Fields

container_resource: Option<ContainerResourceMetricSource>

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.

external: Option<ExternalMetricSource>

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

object: Option<ObjectMetricSource>

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

pods: Option<PodsMetricSource>

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.

resource: Option<ResourceMetricSource>

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.

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

Trait Implementations

impl Clone for MetricSpec

fn clone(&self) -> MetricSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeepMerge for MetricSpec

fn merge_from(&mut self, other: Self)

Merge other into self.

impl Default for MetricSpec

fn default() -> MetricSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricSpec

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MetricSpec

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(__gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for MetricSpec

fn eq(&self, other: &MetricSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MetricSpec

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetricSpec