Skip to content

autoscaling_v2beta1

ContainerResourceMetricSource

class lightkube.models.autoscaling_v2beta1.ContainerResourceMetricSource(container, name, targetAverageUtilization=None, targetAverageValue=None)

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.

parameters

  • container str - container is the name of the container in the pods of the scaling target
  • name str - name is the name of the resource in question.
  • targetAverageUtilization int - (optional) 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.
  • targetAverageValue resource.Quantity - (optional) targetAverageValue 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.

ContainerResourceMetricStatus

class lightkube.models.autoscaling_v2beta1.ContainerResourceMetricStatus(container, currentAverageValue, name, currentAverageUtilization=None)

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.

parameters

  • container str - container is the name of the container in the pods of the scaling target
  • currentAverageValue resource.Quantity - currentAverageValue is the current 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. It will always be set, regardless of the corresponding metric specification.
  • name str - name is the name of the resource in question.
  • currentAverageUtilization int - (optional) 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.

CrossVersionObjectReference

class lightkube.models.autoscaling_v2beta1.CrossVersionObjectReference(kind, name, apiVersion=None)

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

parameters

  • kind str - Kind of the referent; More info
  • name str - Name of the referent; More info
  • apiVersion str - (optional) API version of the referent

ExternalMetricSource

class lightkube.models.autoscaling_v2beta1.ExternalMetricSource(metricName, metricSelector=None, targetAverageValue=None, targetValue=None)

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.

parameters

  • metricName str - metricName is the name of the metric in question.
  • metricSelector meta_v1.LabelSelector - (optional) metricSelector is used to identify a specific time series within a given metric.
  • targetAverageValue resource.Quantity - (optional) targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue.
  • targetValue resource.Quantity - (optional) targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue.

ExternalMetricStatus

class lightkube.models.autoscaling_v2beta1.ExternalMetricStatus(currentValue, metricName, currentAverageValue=None, metricSelector=None)

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

parameters

  • currentValue resource.Quantity - currentValue is the current value of the metric (as a quantity)
  • metricName str - metricName is the name of a metric used for autoscaling in metric system.
  • currentAverageValue resource.Quantity - (optional) currentAverageValue is the current value of metric averaged over autoscaled pods.
  • metricSelector meta_v1.LabelSelector - (optional) metricSelector is used to identify a specific time series within a given metric.

HorizontalPodAutoscaler

class lightkube.models.autoscaling_v2beta1.HorizontalPodAutoscaler(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

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.

parameters

  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) metadata is the standard object metadata. More info
  • spec HorizontalPodAutoscalerSpec - (optional) spec is the specification for the behaviour of the autoscaler. More info
  • status HorizontalPodAutoscalerStatus - (optional) status is the current information about the autoscaler.

HorizontalPodAutoscalerCondition

class lightkube.models.autoscaling_v2beta1.HorizontalPodAutoscalerCondition(status, type, lastTransitionTime=None, message=None, reason=None)

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

parameters

  • status str - status is the status of the condition (True, False, Unknown)
  • type str - type describes the current condition
  • lastTransitionTime meta_v1.Time - (optional) lastTransitionTime is the last time the condition transitioned from one status to another
  • message str - (optional) message is a human-readable explanation containing details about the transition
  • reason str - (optional) reason is the reason for the condition's last transition.

HorizontalPodAutoscalerList

class lightkube.models.autoscaling_v2beta1.HorizontalPodAutoscalerList(items, apiVersion=None, kind=None, metadata=None)

HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects.

parameters

  • items HorizontalPodAutoscaler - items is the list of horizontal pod autoscaler objects.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) metadata is the standard list metadata.

HorizontalPodAutoscalerSpec

class lightkube.models.autoscaling_v2beta1.HorizontalPodAutoscalerSpec(maxReplicas, scaleTargetRef, metrics=None, minReplicas=None)

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

parameters

  • maxReplicas int - maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
  • scaleTargetRef CrossVersionObjectReference - scaleTargetRef 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.
  • metrics MetricSpec - (optional) 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 int - (optional) 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.

HorizontalPodAutoscalerStatus

class lightkube.models.autoscaling_v2beta1.HorizontalPodAutoscalerStatus(currentReplicas, desiredReplicas, conditions=None, currentMetrics=None, lastScaleTime=None, observedGeneration=None)

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

parameters

  • currentReplicas int - currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
  • desiredReplicas int - desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
  • conditions HorizontalPodAutoscalerCondition - (optional) conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
  • currentMetrics MetricStatus - (optional) currentMetrics is the last read state of the metrics used by this autoscaler.
  • lastScaleTime meta_v1.Time - (optional) lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
  • observedGeneration int - (optional) observedGeneration is the most recent generation observed by this autoscaler.

MetricSpec

class lightkube.models.autoscaling_v2beta1.MetricSpec(type, containerResource=None, external=None, object=None, pods=None, resource=None)

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

parameters

  • type str - 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
  • containerResource ContainerResourceMetricSource - (optional) container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of 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. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
  • external ExternalMetricSource - (optional) external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
  • object ObjectMetricSource - (optional) object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
  • pods PodsMetricSource - (optional) pods refers to 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.
  • resource ResourceMetricSource - (optional) resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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.

MetricStatus

class lightkube.models.autoscaling_v2beta1.MetricStatus(type, containerResource=None, external=None, object=None, pods=None, resource=None)

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

parameters

  • type str - 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
  • containerResource ContainerResourceMetricStatus - (optional) container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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.
  • external ExternalMetricStatus - (optional) external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
  • object ObjectMetricStatus - (optional) object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
  • pods PodsMetricStatus - (optional) pods refers to 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.
  • resource ResourceMetricStatus - (optional) resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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.

ObjectMetricSource

class lightkube.models.autoscaling_v2beta1.ObjectMetricSource(metricName, target, targetValue, averageValue=None, selector=None)

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

parameters

  • metricName str - metricName is the name of the metric in question.
  • target CrossVersionObjectReference - target is the described Kubernetes object.
  • targetValue resource.Quantity - targetValue is the target value of the metric (as a quantity).
  • averageValue resource.Quantity - (optional) averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
  • selector meta_v1.LabelSelector - (optional) selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.

ObjectMetricStatus

class lightkube.models.autoscaling_v2beta1.ObjectMetricStatus(currentValue, metricName, target, averageValue=None, selector=None)

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

parameters

  • currentValue resource.Quantity - currentValue is the current value of the metric (as a quantity).
  • metricName str - metricName is the name of the metric in question.
  • target CrossVersionObjectReference - target is the described Kubernetes object.
  • averageValue resource.Quantity - (optional) averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
  • selector meta_v1.LabelSelector - (optional) selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the ObjectMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

PodsMetricSource

class lightkube.models.autoscaling_v2beta1.PodsMetricSource(metricName, targetAverageValue, selector=None)

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.

parameters

  • metricName str - metricName is the name of the metric in question
  • targetAverageValue resource.Quantity - targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)
  • selector meta_v1.LabelSelector - (optional) selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.

PodsMetricStatus

class lightkube.models.autoscaling_v2beta1.PodsMetricStatus(currentAverageValue, metricName, selector=None)

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

parameters

  • currentAverageValue resource.Quantity - currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
  • metricName str - metricName is the name of the metric in question
  • selector meta_v1.LabelSelector - (optional) selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the PodsMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

ResourceMetricSource

class lightkube.models.autoscaling_v2beta1.ResourceMetricSource(name, targetAverageUtilization=None, targetAverageValue=None)

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.

parameters

  • name str - name is the name of the resource in question.
  • targetAverageUtilization int - (optional) 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.
  • targetAverageValue resource.Quantity - (optional) targetAverageValue 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.

ResourceMetricStatus

class lightkube.models.autoscaling_v2beta1.ResourceMetricStatus(currentAverageValue, name, currentAverageUtilization=None)

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.

parameters

  • currentAverageValue resource.Quantity - currentAverageValue is the current 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. It will always be set, regardless of the corresponding metric specification.
  • name str - name is the name of the resource in question.
  • currentAverageUtilization int - (optional) 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.