case class HorizontalPodAutoscalerSpec(maxReplicas: Int, metrics: Optional[Vector[MetricSpec]] = Optional.Absent, minReplicas: Optional[Int] = Optional.Absent, scaleTargetRef: CrossVersionObjectReference) extends Product with Serializable

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

maxReplicas

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

metrics

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.

minReplicas

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HorizontalPodAutoscalerSpec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HorizontalPodAutoscalerSpec(maxReplicas: Int, metrics: Optional[Vector[MetricSpec]] = Optional.Absent, minReplicas: Optional[Int] = Optional.Absent, scaleTargetRef: CrossVersionObjectReference)

    maxReplicas

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

    metrics

    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.

    minReplicas

    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.

Value Members

  1. def getMaxReplicas: IO[K8sFailure, Int]

    maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.

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

    This effect always succeeds, it is safe to use the field maxReplicas directly.

  2. def getMetrics: IO[K8sFailure, Vector[MetricSpec]]

    metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used).

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  3. def getMinReplicas: IO[K8sFailure, Int]

    minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  4. def getScaleTargetRef: IO[K8sFailure, CrossVersionObjectReference]

    Gets scaleTargetRef.

    Gets scaleTargetRef.

    This effect always succeeds, it is safe to use the field scaleTargetRef directly.

  5. val maxReplicas: Int
  6. val metrics: Optional[Vector[MetricSpec]]
  7. val minReplicas: Optional[Int]
  8. val scaleTargetRef: CrossVersionObjectReference