VerticalPodAutoscaler is the configuration for a vertical pod autoscaler, which automatically manages pod resources based on historical and real time resource utilization.
Last changed in Vertical Pod Autoscaler 0.10.0
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/sig-architecture/api-conventions.md#resources
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/sig-architecture/api-conventions.md#types-kinds
Specification of the behavior of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
Recommender responsible for generating recommendation for this object. List should be empty (then the default recommender will generate the recommendation) or contain exactly one recommender.
Name of the recommender responsible for generating recommendation for this object.
Controls how the autoscaler computes recommended resources. The resource policy may be used to set constraints on the recommendations for individual containers. If any individual containers need to be excluded from getting the VPA recommendations, then it must be disabled explicitly by setting mode to "Off" under containerPolicies. If not specified, the autoscaler computes recommended resources for all containers in the pod, without additional constraints.
Per-container resource policies.
Name of the container or DefaultContainerResourcePolicy, in which case the policy is used by the containers that don't have their own policy specified.
Specifies the type of recommendations that will be computed (and possibly applied) by VPA. If not specified, the default of [ResourceCPU, ResourceMemory] will be used.
Specifies which resource values should be controlled. The default is "RequestsAndLimits".
Specifies the maximum amount of resources that will be recommended for the container. The default is no maximum.
memoryAggregationIntervalCount is the number of consecutive memoryAggregationIntervals which make up the memory aggregation window. The total window length is: MemoryAggregationIntervalSeconds * MemoryAggregationIntervalCount.
memoryAggregationIntervalSeconds is the length of a single interval (in seconds) for which the peak memory usage is computed. Memory usage peaks are aggregated in multiples of this interval. In other words, there is one memory usage sample per interval (the maximum usage over that interval).
Specifies the minimal amount of resources that will be recommended for the container. The default is no minimum.
Whether autoscaler is enabled for the container. The default is "Auto".
oomBumpUpRatio is the ratio to increase memory when OOM is detected.
oomMinBumpUp is the minimum increase in memory when OOM is detected.
startupBoost specifies the startup boost policy for the container. This overrides any pod-level startup boost policy. The startup boost policy takes precedence over the rest of the fields in this struct, except for ContainerName and ControlledValues.
cpu specifies the CPU startup boost policy. If this field is not set, no startup boost is applied.
durationSeconds indicates for how long to keep the pod boosted after it goes to Ready. Defaults to 0.
factor specifies the factor to apply to the resource request. This field is required when Type is "Factor".
quantity specifies the absolute resource quantity to be used as the resource request and limit during the boost phase. This field is required when Type is "Quantity".
type specifies the kind of boost to apply. Supported values are: "Factor", "Quantity". No startupboost will be applied for unrecognized values.
startupBoost specifies the startup boost policy for the pod.
cpu specifies the CPU startup boost policy. If this field is not set, no startup boost is applied.
durationSeconds indicates for how long to keep the pod boosted after it goes to Ready. Defaults to 0.
factor specifies the factor to apply to the resource request. This field is required when Type is "Factor".
quantity specifies the absolute resource quantity to be used as the resource request and limit during the boost phase. This field is required when Type is "Quantity".
type specifies the kind of boost to apply. Supported values are: "Factor", "Quantity". No startupboost will be applied for unrecognized values.
TargetRef points to the controller managing the set of pods for the autoscaler to control - e.g. Deployment, StatefulSet. VerticalPodAutoscaler can be targeted at controller implementing scale subresource (the pod set is retrieved from the controller's ScaleStatus) or some well known controllers (e.g. for DaemonSet the pod set is read from the controller's spec). If VerticalPodAutoscaler cannot use specified target it will report ConfigUnsupported condition. Note that VerticalPodAutoscaler does not require full implementation of scale subresource - it will not use it to modify the replica count. The only thing retrieved is a label selector matching pods grouped by the target resource.
apiVersion is the API version of the referent
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Describes the rules on how changes are applied to the pods. If not specified, all fields in the `PodUpdatePolicy` are set to their default values.
evictAfterOOMSeconds specifies the time in seconds to wait after an OOM event before considering the pod for eviction. Pods that have OOMed in less than this time since start will be evicted.
EvictionRequirements is a list of EvictionRequirements that need to evaluate to true in order for a Pod to be evicted. If more than one EvictionRequirement is specified, all of them need to be fulfilled to allow eviction.
EvictionChangeRequirement refers to the relationship between the new target recommendation for a Pod and its current requests, what kind of change is necessary for the Pod to be evicted
Resources is a list of one or more resources that the condition applies to. If more than one resource is given, the EvictionRequirement is fulfilled if at least one resource meets `changeRequirement`.
Minimal number of replicas which need to be alive for Updater to attempt pod eviction (pending other checks like PDB). Only positive values are allowed. Overrides global '--min-replicas' flag.
Controls when autoscaler applies changes to the pod resources. The default is 'Recreate'.
Current information about the autoscaler.
Conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
lastTransitionTime is the last time the condition transitioned from one status to another
message is a human-readable explanation containing details about the transition
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason is the reason for the condition's last transition.
status is the status of the condition (True, False, Unknown)
type describes the current condition
observedGeneration is the most recent generation observed by this autoscaler.
The most recently computed amount of resources recommended by the autoscaler for the controlled pods.
Resources recommended by the autoscaler for each container.
Name of the container.
Minimum recommended amount of resources. Observes ContainerResourcePolicy. This amount is not guaranteed to be sufficient for the application to operate in a stable way, however running with less resources is likely to have significant impact on performance/availability.
Recommended amount of resources. Observes ContainerResourcePolicy.
The most recent recommended resources target computed by the autoscaler for the controlled pods, based only on actual resource usage, not taking into account the ContainerResourcePolicy. May differ from the Recommendation if the actual resource usage causes the target to violate the ContainerResourcePolicy (lower than MinAllowed or higher that MaxAllowed). Used only as status indication, will not affect actual resource assignment.
Maximum recommended amount of resources. Observes ContainerResourcePolicy. Any resources allocated beyond this value are likely wasted. This value may be larger than the maximum amount of application is actually capable of consuming.
Source: vpa-v1-crd-gen.yaml
Changes to VerticalPodAutoscaler (autoscaling.k8s.io/v1) in each Vertical Pod Autoscaler version, compared to the version before it.
4 properties have been added
Released · View VerticalPodAutoscaler in 0.10.0
3 properties have been added
Released · View VerticalPodAutoscaler in 0.8.1
1 property has changed the description
Released · View VerticalPodAutoscaler in 0.7.0
2 properties have been added
Released · View VerticalPodAutoscaler in 0.6.0
VerticalPodAutoscaler was already present in this version of Vertical Pod Autoscaler, the oldest one on kubespec.dev
Released · View VerticalPodAutoscaler in 0.4.0
No examples of VerticalPodAutoscaler yet. Contribute one on GitHub.
kubespec.dev