/** * @module autoscaling/v2beta1 * @internal */ import { DeleteOptions as _DeleteOptions_5 } from "./../meta/v1"; import { ListMeta as _ListMeta_3 } from "./../meta/v1"; import { ObjectMeta as _ObjectMeta_1 } from "./../meta/v1"; import { Quantity as _Quantity_4 } from "./../apimachinery/resource"; import { Time as _Time_2 } from "./../meta/v1"; import { WatchEvent as _WatchEvent_6 } from "./../meta/v1"; /** * CrossVersionObjectReference contains enough information to let you identify the referred resource. */ export declare interface CrossVersionObjectReference { /** * API version of the referent */ apiVersion?: string; /** * Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" */ kind: string; /** * Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names */ name: string; } /** * 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. */ export declare interface HorizontalPodAutoscaler { /** * 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources */ apiVersion: "autoscaling/v2beta1"; /** * 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds */ kind: "HorizontalPodAutoscaler"; /** * metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata */ metadata?: _ObjectMeta_1; /** * spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. */ spec?: HorizontalPodAutoscalerSpec; /** * status is the current information about the autoscaler. */ status?: HorizontalPodAutoscalerStatus; } /** * HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point. */ export declare interface HorizontalPodAutoscalerCondition { /** * lastTransitionTime is the last time the condition transitioned from one status to another */ lastTransitionTime?: _Time_2; /** * message is a human-readable explanation containing details about the transition */ message?: string; /** * reason is the reason for the condition's last transition. */ reason?: string; /** * status is the status of the condition (True, False, Unknown) */ status: string; /** * type describes the current condition */ type: string; } /** * HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects. */ export declare interface HorizontalPodAutoscalerList { /** * 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources */ apiVersion: "autoscaling/v2beta1"; /** * items is the list of horizontal pod autoscaler objects. */ items: Iterable; /** * 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds */ kind: "HorizontalPodAutoscalerList"; /** * metadata is the standard list metadata. */ metadata?: _ListMeta_3; } /** * HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. */ export declare interface HorizontalPodAutoscalerSpec { /** * maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. */ maxReplicas: number; /** * 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. */ metrics?: Iterable; /** * minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. */ minReplicas?: number; /** * 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. */ scaleTargetRef: CrossVersionObjectReference; } /** * HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler. */ export declare interface HorizontalPodAutoscalerStatus { /** * conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. */ conditions: Iterable; /** * currentMetrics is the last read state of the metrics used by this autoscaler. */ currentMetrics: Iterable; /** * currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. */ currentReplicas: number; /** * desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. */ desiredReplicas: number; /** * 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. */ lastScaleTime?: _Time_2; /** * observedGeneration is the most recent generation observed by this autoscaler. */ observedGeneration?: number; } /** * MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once). */ export declare interface MetricSpec { /** * object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). */ object?: ObjectMetricSource; /** * 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. */ pods?: PodsMetricSource; /** * 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. */ resource?: ResourceMetricSource; /** * type is the type of metric source. It should match one of the fields below. */ type: string; } /** * MetricStatus describes the last-read state of a single metric. */ export declare interface MetricStatus { /** * object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). */ object?: ObjectMetricStatus; /** * 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. */ pods?: PodsMetricStatus; /** * 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. */ resource?: ResourceMetricStatus; /** * type is the type of metric source. It will match one of the fields below. */ type: string; } /** * ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). */ export declare interface ObjectMetricSource { /** * metricName is the name of the metric in question. */ metricName: string; /** * target is the described Kubernetes object. */ target: CrossVersionObjectReference; /** * targetValue is the target value of the metric (as a quantity). */ targetValue: _Quantity_4; } /** * ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). */ export declare interface ObjectMetricStatus { /** * currentValue is the current value of the metric (as a quantity). */ currentValue: _Quantity_4; /** * metricName is the name of the metric in question. */ metricName: string; /** * target is the described Kubernetes object. */ target: CrossVersionObjectReference; } /** * 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. */ export declare interface PodsMetricSource { /** * metricName is the name of the metric in question */ metricName: string; /** * targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity) */ targetAverageValue: _Quantity_4; } /** * PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second). */ export declare interface PodsMetricStatus { /** * currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity) */ currentAverageValue: _Quantity_4; /** * metricName is the name of the metric in question */ metricName: string; } /** * 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. */ export declare interface ResourceMetricSource { /** * name is the name of the resource in question. */ name: string; /** * 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. */ targetAverageUtilization?: number; /** * 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. */ targetAverageValue?: _Quantity_4; } /** * 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. */ export declare interface ResourceMetricStatus { /** * 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. */ currentAverageUtilization?: number; /** * 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. */ currentAverageValue: _Quantity_4; /** * name is the name of the resource in question. */ name: string; } export declare type DeleteOptions = _DeleteOptions_5; export declare type WatchEvent = _WatchEvent_6;