package kubecaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Resource_metric_source 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 t
val to_yojson : t -> Yojson.Safe.t
val make : ?target_average_value: Kubernetes.Definitions.Apimachinery.Pkg.Api.Resource.Quantity.t -> ?target_average_utilization:int -> name:string -> unit -> t
val name : t -> string

name is the name of the resource in question.

val target_average_utilization : t -> int option

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

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

module Object : Object.S with type value := t