package kubecaml

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

Horizontal_pod_autoscaler_spec describes the desired functionality of the Horizontal_pod_autoscaler.

type t
val to_yojson : t -> Yojson.Safe.t
val make : scale_target_ref: Kubernetes.Definitions.Api.Autoscaling.V2beta1.Cross_version_object_reference.t -> ?min_replicas:int -> ?metrics:Kubernetes.Definitions.Api.Autoscaling.V2beta1.Metric_spec.t list -> max_replicas:int -> unit -> t
val max_replicas : t -> int

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

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.

val min_replicas : t -> int option

min_replicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod.

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

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