Type Members

1.  case class ContainerResourceMetricSource(container: String, name: String, target: MetricTarget) extends Product with Serializable

   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.

   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.

   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.

2.  class ContainerResourceMetricSourceFields extends AnyRef
3.  case class ContainerResourceMetricStatus(container: String, current: MetricValueStatus, name: String) extends Product with Serializable

   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.

   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.

   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.

4.  class ContainerResourceMetricStatusFields extends AnyRef
5.  case class CrossVersionObjectReference(apiVersion: Optional[String] = Optional.Absent, kind: String, name: String) extends Product with Serializable

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

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

   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

6.  class CrossVersionObjectReferenceFields extends AnyRef
7.  case class ExternalMetricSource(metric: MetricIdentifier, target: MetricTarget) extends Product with Serializable

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

8.  class ExternalMetricSourceFields extends AnyRef
9.  case class ExternalMetricStatus(current: MetricValueStatus, metric: MetricIdentifier) extends Product with Serializable

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

10.  class ExternalMetricStatusFields extends AnyRef
11.  case class HPAScalingPolicy(periodSeconds: Int, type: String, value: Int) extends Product with Serializable

    HPAScalingPolicy is a single policy which must hold true for a specified past interval.

    HPAScalingPolicy is a single policy which must hold true for a specified past interval.

    periodSeconds

    PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).

    type

    Type is used to specify the scaling policy.

    value

    Value contains the amount of change which is permitted by the policy. It must be greater than zero

12.  class HPAScalingPolicyFields extends AnyRef
13.  case class HPAScalingRules(policies: Optional[Vector[HPAScalingPolicy]] = Optional.Absent, selectPolicy: Optional[String] = Optional.Absent, stabilizationWindowSeconds: Optional[Int] = Optional.Absent) extends Product with Serializable

    HPAScalingRules configures the scaling behavior for one direction.

    HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.

    policies

    policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid

    selectPolicy

    selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.

    stabilizationWindowSeconds

    StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).

14.  class HPAScalingRulesFields extends AnyRef
15.  case class HorizontalPodAutoscaler(metadata: Optional[ObjectMeta] = Optional.Absent, spec: Optional[HorizontalPodAutoscalerSpec] = Optional.Absent, status: Optional[HorizontalPodAutoscalerStatus] = Optional.Absent) extends Product with Serializable

    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.

16.  case class HorizontalPodAutoscalerBehavior(scaleDown: Optional[HPAScalingRules] = Optional.Absent, scaleUp: Optional[HPAScalingRules] = Optional.Absent) extends Product with Serializable

    HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

17.  class HorizontalPodAutoscalerBehaviorFields extends AnyRef
18.  case class HorizontalPodAutoscalerCondition(lastTransitionTime: Optional[Time] = Optional.Absent, message: Optional[String] = Optional.Absent, reason: Optional[String] = Optional.Absent, status: String, type: String) extends Product with Serializable

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

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

    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

19.  class HorizontalPodAutoscalerConditionFields extends AnyRef
20.  class HorizontalPodAutoscalerFields extends AnyRef
21.  case class HorizontalPodAutoscalerSpec(behavior: Optional[HorizontalPodAutoscalerBehavior] = Optional.Absent, 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.

    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. If not set, the default metric will be set to 80% average CPU utilization.

    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.

22.  class HorizontalPodAutoscalerSpecFields extends AnyRef
23.  case class HorizontalPodAutoscalerStatus(conditions: Optional[Vector[HorizontalPodAutoscalerCondition]] = Optional.Absent, currentMetrics: Optional[Vector[MetricStatus]] = Optional.Absent, currentReplicas: Optional[Int] = Optional.Absent, desiredReplicas: Int, lastScaleTime: Optional[Time] = Optional.Absent, observedGeneration: Optional[Long] = Optional.Absent) extends Product with Serializable

    HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

    HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

    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.

24.  class HorizontalPodAutoscalerStatusFields extends AnyRef
25.  case class MetricIdentifier(name: String, selector: Optional[LabelSelector] = Optional.Absent) extends Product with Serializable

    MetricIdentifier defines the name and optionally selector for a metric

    MetricIdentifier defines the name and optionally selector for a metric

    name

    name is the name of the given metric

26.  class MetricIdentifierFields extends AnyRef
27.  case class MetricSpec(containerResource: Optional[ContainerResourceMetricSource] = Optional.Absent, external: Optional[ExternalMetricSource] = Optional.Absent, object: Optional[ObjectMetricSource] = Optional.Absent, pods: Optional[PodsMetricSource] = Optional.Absent, resource: Optional[ResourceMetricSource] = Optional.Absent, type: String) extends Product with Serializable

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

    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

28.  class MetricSpecFields extends AnyRef
29.  case class MetricStatus(containerResource: Optional[ContainerResourceMetricStatus] = Optional.Absent, external: Optional[ExternalMetricStatus] = Optional.Absent, object: Optional[ObjectMetricStatus] = Optional.Absent, pods: Optional[PodsMetricStatus] = Optional.Absent, resource: Optional[ResourceMetricStatus] = Optional.Absent, type: String) extends Product with Serializable

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

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

    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

30.  class MetricStatusFields extends AnyRef
31.  case class MetricTarget(averageUtilization: Optional[Int] = Optional.Absent, averageValue: Optional[Quantity] = Optional.Absent, type: String, value: Optional[Quantity] = Optional.Absent) extends Product with Serializable

    MetricTarget defines the target value, average value, or average utilization of a specific metric

    MetricTarget defines the target value, average value, or average utilization of a specific metric

    averageUtilization

    averageUtilization 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. Currently only valid for Resource metric source type

    type

    type represents whether the metric type is Utilization, Value, or AverageValue

32.  class MetricTargetFields extends AnyRef
33.  case class MetricValueStatus(averageUtilization: Optional[Int] = Optional.Absent, averageValue: Optional[Quantity] = Optional.Absent, value: Optional[Quantity] = Optional.Absent) extends Product with Serializable

    MetricValueStatus holds the current value for a metric

    MetricValueStatus holds the current value for a metric

    averageUtilization

    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.

34.  class MetricValueStatusFields extends AnyRef
35.  case class ObjectMetricSource(describedObject: CrossVersionObjectReference, metric: MetricIdentifier, target: MetricTarget) extends Product with Serializable

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

36.  class ObjectMetricSourceFields extends AnyRef
37.  case class ObjectMetricStatus(current: MetricValueStatus, describedObject: CrossVersionObjectReference, metric: MetricIdentifier) extends Product with Serializable

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

38.  class ObjectMetricStatusFields extends AnyRef
39.  case class PodsMetricSource(metric: MetricIdentifier, target: MetricTarget) extends Product with Serializable

    PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

    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.

40.  class PodsMetricSourceFields extends AnyRef
41.  case class PodsMetricStatus(current: MetricValueStatus, metric: MetricIdentifier) extends Product with Serializable

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

42.  class PodsMetricStatusFields extends AnyRef
43.  case class ResourceMetricSource(name: String, target: MetricTarget) extends Product with Serializable

    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.

    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.

    name

    name is the name of the resource in question.

44.  class ResourceMetricSourceFields extends AnyRef
45.  case class ResourceMetricStatus(current: MetricValueStatus, name: String) extends Product with Serializable

    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.

    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.

    name

    Name is the name of the resource in question.

46.  class ResourceMetricStatusFields extends AnyRef