Kubernetes.Api.Autoscaling.V2Beta1

newtype CrossVersionObjectReference

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

Fields:

• apiVersion: API version of the referent
• kind: Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
• name: Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

Constructors

• CrossVersionObjectReference { apiVersion :: Maybe String, kind :: Maybe String, name :: Maybe String }

Instances

• Newtype CrossVersionObjectReference _
• Generic CrossVersionObjectReference _
• Show CrossVersionObjectReference
• Decode CrossVersionObjectReference
• Encode CrossVersionObjectReference
• Default CrossVersionObjectReference

newtype HorizontalPodAutoscaler

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.

Fields:

• metadata: metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
• spec: 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.
• status: status is the current information about the autoscaler.

Constructors

• HorizontalPodAutoscaler { metadata :: Maybe ObjectMeta, spec :: Maybe HorizontalPodAutoscalerSpec, status :: Maybe HorizontalPodAutoscalerStatus }

Instances

• Newtype HorizontalPodAutoscaler _
• Generic HorizontalPodAutoscaler _
• Show HorizontalPodAutoscaler
• Decode HorizontalPodAutoscaler
• Encode HorizontalPodAutoscaler
• Default HorizontalPodAutoscaler

newtype HorizontalPodAutoscalerCondition

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

Fields:

• _type: type describes the current condition
• lastTransitionTime: lastTransitionTime is the last time the condition transitioned from one status to another
• 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)

Constructors

• HorizontalPodAutoscalerCondition { _type :: Maybe String, lastTransitionTime :: Maybe Time, message :: Maybe String, reason :: Maybe String, status :: Maybe String }

Instances

• Newtype HorizontalPodAutoscalerCondition _
• Generic HorizontalPodAutoscalerCondition _
• Show HorizontalPodAutoscalerCondition
• Decode HorizontalPodAutoscalerCondition
• Encode HorizontalPodAutoscalerCondition
• Default HorizontalPodAutoscalerCondition

newtype HorizontalPodAutoscalerList

HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects.

Fields:

• items: items is the list of horizontal pod autoscaler objects.
• metadata: metadata is the standard list metadata.

Constructors

• HorizontalPodAutoscalerList { items :: Maybe (Array HorizontalPodAutoscaler), metadata :: Maybe ListMeta }

Instances

• Newtype HorizontalPodAutoscalerList _
• Generic HorizontalPodAutoscalerList _
• Show HorizontalPodAutoscalerList
• Decode HorizontalPodAutoscalerList
• Encode HorizontalPodAutoscalerList
• Default HorizontalPodAutoscalerList

newtype HorizontalPodAutoscalerSpec

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Fields:

• 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.
• scaleTargetRef: 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.

Constructors

• HorizontalPodAutoscalerSpec { maxReplicas :: Maybe Int, metrics :: Maybe (Array MetricSpec), minReplicas :: Maybe Int, scaleTargetRef :: Maybe CrossVersionObjectReference }

Instances

• Newtype HorizontalPodAutoscalerSpec _
• Generic HorizontalPodAutoscalerSpec _
• Show HorizontalPodAutoscalerSpec
• Decode HorizontalPodAutoscalerSpec
• Encode HorizontalPodAutoscalerSpec
• Default HorizontalPodAutoscalerSpec

newtype HorizontalPodAutoscalerStatus

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

Fields:

• 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.
• lastScaleTime: 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: observedGeneration is the most recent generation observed by this autoscaler.

Constructors

• HorizontalPodAutoscalerStatus { conditions :: Maybe (Array HorizontalPodAutoscalerCondition), currentMetrics :: Maybe (Array MetricStatus), currentReplicas :: Maybe Int, desiredReplicas :: Maybe Int, lastScaleTime :: Maybe Time, observedGeneration :: Maybe Int }

Instances

• Newtype HorizontalPodAutoscalerStatus _
• Generic HorizontalPodAutoscalerStatus _
• Show HorizontalPodAutoscalerStatus
• Decode HorizontalPodAutoscalerStatus
• Encode HorizontalPodAutoscalerStatus
• Default HorizontalPodAutoscalerStatus

newtype MetricSpec

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

Fields:

• _type: type is the type of metric source. It should be one of "Object", "Pods" or "Resource", each mapping to a matching field in the object.
• object: object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
• pods: 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: 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.

Constructors

• MetricSpec { _type :: Maybe String, object :: Maybe ObjectMetricSource, pods :: Maybe PodsMetricSource, resource :: Maybe ResourceMetricSource }

Instances

• Newtype MetricSpec _
• Generic MetricSpec _
• Show MetricSpec
• Decode MetricSpec
• Encode MetricSpec
• Default MetricSpec

newtype MetricStatus

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

Fields:

• _type: type is the type of metric source. It will be one of "Object", "Pods" or "Resource", each corresponds to a matching field in the object.
• object: object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
• pods: 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: 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.

Constructors

• MetricStatus { _type :: Maybe String, object :: Maybe ObjectMetricStatus, pods :: Maybe PodsMetricStatus, resource :: Maybe ResourceMetricStatus }

Instances

• Newtype MetricStatus _
• Generic MetricStatus _
• Show MetricStatus
• Decode MetricStatus
• Encode MetricStatus
• Default MetricStatus

newtype ObjectMetricSource

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

Fields:

• metricName: metricName is the name of the metric in question.
• target: target is the described Kubernetes object.
• targetValue: targetValue is the target value of the metric (as a quantity).

Constructors

• ObjectMetricSource { metricName :: Maybe String, target :: Maybe CrossVersionObjectReference, targetValue :: Maybe Quantity }

Instances

• Newtype ObjectMetricSource _
• Generic ObjectMetricSource _
• Show ObjectMetricSource
• Decode ObjectMetricSource
• Encode ObjectMetricSource
• Default ObjectMetricSource

newtype ObjectMetricStatus

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

Fields:

• currentValue: currentValue is the current value of the metric (as a quantity).
• metricName: metricName is the name of the metric in question.
• target: target is the described Kubernetes object.

Constructors

• ObjectMetricStatus { currentValue :: Maybe Quantity, metricName :: Maybe String, target :: Maybe CrossVersionObjectReference }

Instances

• Newtype ObjectMetricStatus _
• Generic ObjectMetricStatus _
• Show ObjectMetricStatus
• Decode ObjectMetricStatus
• Encode ObjectMetricStatus
• Default ObjectMetricStatus

newtype PodsMetricSource

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.

Fields:

• metricName: metricName is the name of the metric in question
• targetAverageValue: targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)

Constructors

• PodsMetricSource { metricName :: Maybe String, targetAverageValue :: Maybe Quantity }

Instances

• Newtype PodsMetricSource _
• Generic PodsMetricSource _
• Show PodsMetricSource
• Decode PodsMetricSource
• Encode PodsMetricSource
• Default PodsMetricSource

newtype PodsMetricStatus

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

Fields:

• currentAverageValue: currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
• metricName: metricName is the name of the metric in question

Constructors

• PodsMetricStatus { currentAverageValue :: Maybe Quantity, metricName :: Maybe String }

Instances

• Newtype PodsMetricStatus _
• Generic PodsMetricStatus _
• Show PodsMetricStatus
• Decode PodsMetricStatus
• Encode PodsMetricStatus
• Default PodsMetricStatus

newtype ResourceMetricSource

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.

Fields:

• 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.
• targetAverageValue: 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.

Constructors

• ResourceMetricSource { name :: Maybe String, targetAverageUtilization :: Maybe Int, targetAverageValue :: Maybe Quantity }

Instances

• Newtype ResourceMetricSource _
• Generic ResourceMetricSource _
• Show ResourceMetricSource
• Decode ResourceMetricSource
• Encode ResourceMetricSource
• Default ResourceMetricSource

newtype ResourceMetricStatus

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.

Fields:

• 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.
• currentAverageValue: 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: name is the name of the resource in question.

Constructors

• ResourceMetricStatus { currentAverageUtilization :: Maybe Int, currentAverageValue :: Maybe Quantity, name :: Maybe String }

Instances

• Newtype ResourceMetricStatus _
• Generic ResourceMetricStatus _
• Show ResourceMetricStatus
• Decode ResourceMetricStatus
• Encode ResourceMetricStatus
• Default ResourceMetricStatus

getAPIResources :: forall e. Config -> Aff (http :: HTTP | e) (Either Status APIResourceList)

get available resources