zio-k8s-client
API
Generated with
zio-k8s-client/com.coralogix.zio.k8s/com.coralogix.zio.k8s.model/com.coralogix.zio.k8s.model.autoscaling/com.coralogix.zio.k8s.model.autoscaling.v2beta1

com.coralogix.zio.k8s.model.autoscaling.v2beta1

package com.coralogix.zio.k8s.model.autoscaling.v2beta1

Members list

Type members

Classlikes

case class ContainerResourceMetricSource(container: String, name: String, targetAverageUtilization: Optional[Int], targetAverageValue: Optional[Quantity])

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

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

Value parameters

container

container is the name of the container in the pods of the scaling target

name

name is the name of the resource in question.

targetAverageUtilization

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ContainerResourceMetricSource extends ContainerResourceMetricSourceFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ContainerResourceMetricSourceFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ContainerResourceMetricStatus(container: String, currentAverageUtilization: Optional[Int], currentAverageValue: Quantity, name: String)

ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in 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.

ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in 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.

Value parameters

container

container is the name of the container in the pods of the scaling target

currentAverageUtilization

currentAverageUtilization is the current 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. It will only be present if targetAverageValue was set in the corresponding metric specification.

name

name is the name of the resource in question.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ContainerResourceMetricStatus extends ContainerResourceMetricStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ContainerResourceMetricStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class CrossVersionObjectReference(apiVersion: Optional[String], kind: String, name: String)

CrossVersionObjectReference contains enough information to let you identify the referred resource.

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Value parameters

apiVersion

API version of the referent

kind

Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

name

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CrossVersionObjectReference extends CrossVersionObjectReferenceFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class CrossVersionObjectReferenceFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ExternalMetricSource(metricName: String, metricSelector: Optional[LabelSelector], targetAverageValue: Optional[Quantity], targetValue: Optional[Quantity])

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). Exactly one "target" type should be set.

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). Exactly one "target" type should be set.

Value parameters

metricName

metricName is the name of the metric in question.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExternalMetricSource extends ExternalMetricSourceFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ExternalMetricSourceFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ExternalMetricSource.type
case class ExternalMetricStatus(currentAverageValue: Optional[Quantity], currentValue: Quantity, metricName: String, metricSelector: Optional[LabelSelector])

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

Value parameters

metricName

metricName is the name of a metric used for autoscaling in metric system.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExternalMetricStatus extends ExternalMetricStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ExternalMetricStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ExternalMetricStatus.type
case class HorizontalPodAutoscaler(metadata: Optional[ObjectMeta], spec: Optional[HorizontalPodAutoscalerSpec], status: Optional[HorizontalPodAutoscalerStatus])

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HorizontalPodAutoscaler extends HorizontalPodAutoscalerFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
case class HorizontalPodAutoscalerCondition(lastTransitionTime: Optional[Time], message: Optional[String], reason: Optional[String], status: String, `type`: String)

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

Value parameters

message

message is a human-readable explanation containing details about the transition

reason

reason is the reason for the condition's last transition.

status

status is the status of the condition (True, False, Unknown)

type

type describes the current condition

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HorizontalPodAutoscalerCondition extends HorizontalPodAutoscalerConditionFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class HorizontalPodAutoscalerConditionFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class HorizontalPodAutoscalerFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class HorizontalPodAutoscalerSpec(maxReplicas: Int, metrics: Optional[Vector[MetricSpec]], minReplicas: Optional[Int], scaleTargetRef: CrossVersionObjectReference)

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Value parameters

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HorizontalPodAutoscalerSpec extends HorizontalPodAutoscalerSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class HorizontalPodAutoscalerSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class HorizontalPodAutoscalerStatus(conditions: Optional[Vector[HorizontalPodAutoscalerCondition]], currentMetrics: Optional[Vector[MetricStatus]], currentReplicas: Int, desiredReplicas: Int, lastScaleTime: Optional[Time], observedGeneration: Optional[Long])

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

Value parameters

conditions

conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.

currentMetrics

currentMetrics is the last read state of the metrics used by this autoscaler.

currentReplicas

currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.

desiredReplicas

desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.

observedGeneration

observedGeneration is the most recent generation observed by this autoscaler.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HorizontalPodAutoscalerStatus extends HorizontalPodAutoscalerStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class HorizontalPodAutoscalerStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class MetricSpec(containerResource: Optional[ContainerResourceMetricSource], external: Optional[ExternalMetricSource], `object`: Optional[ObjectMetricSource], pods: Optional[PodsMetricSource], resource: Optional[ResourceMetricSource], `type`: String)

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

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

Value parameters

type

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MetricSpec extends MetricSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
MetricSpec.type
class MetricSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object MetricSpec.type
case class MetricStatus(containerResource: Optional[ContainerResourceMetricStatus], external: Optional[ExternalMetricStatus], `object`: Optional[ObjectMetricStatus], pods: Optional[PodsMetricStatus], resource: Optional[ResourceMetricStatus], `type`: String)

MetricStatus describes the last-read state of a single metric.

MetricStatus describes the last-read state of a single metric.

Value parameters

type

type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MetricStatus extends MetricStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class MetricStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object MetricStatus.type
case class ObjectMetricSource(averageValue: Optional[Quantity], metricName: String, selector: Optional[LabelSelector], target: CrossVersionObjectReference, targetValue: Quantity)

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Value parameters

metricName

metricName is the name of the metric in question.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ObjectMetricSource extends ObjectMetricSourceFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ObjectMetricSourceFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ObjectMetricSource.type
case class ObjectMetricStatus(averageValue: Optional[Quantity], currentValue: Quantity, metricName: String, selector: Optional[LabelSelector], target: CrossVersionObjectReference)

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Value parameters

metricName

metricName is the name of the metric in question.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ObjectMetricStatus extends ObjectMetricStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ObjectMetricStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ObjectMetricStatus.type
case class PodsMetricSource(metricName: String, selector: Optional[LabelSelector], targetAverageValue: Quantity)

PodsMetricSource indicates how to scale on 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.

PodsMetricSource indicates how to scale on 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.

Value parameters

metricName

metricName is the name of the metric in question

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PodsMetricSource extends PodsMetricSourceFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class PodsMetricSourceFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PodsMetricSource.type
case class PodsMetricStatus(currentAverageValue: Quantity, metricName: String, selector: Optional[LabelSelector])

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

Value parameters

metricName

metricName is the name of the metric in question

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PodsMetricStatus extends PodsMetricStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class PodsMetricStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PodsMetricStatus.type
case class ResourceMetricSource(name: String, targetAverageUtilization: Optional[Int], targetAverageValue: Optional[Quantity])

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

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

Value parameters

name

name is the name of the resource in question.

targetAverageUtilization

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceMetricSource extends ResourceMetricSourceFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ResourceMetricSourceFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ResourceMetricSource.type
case class ResourceMetricStatus(currentAverageUtilization: Optional[Int], currentAverageValue: Quantity, name: String)

ResourceMetricStatus indicates the current value of 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). 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.

ResourceMetricStatus indicates the current value of 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). 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.

Value parameters

currentAverageUtilization

currentAverageUtilization is the current 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. It will only be present if targetAverageValue was set in the corresponding metric specification.

name

name is the name of the resource in question.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceMetricStatus extends ResourceMetricStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ResourceMetricStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ResourceMetricStatus.type
Generated with