README
¶
Vertical Pod Autoscaler
Contents
- Contents
- Intro
- Getting started
- Components and Architecture
- Features and Known limitations
- Related links
Intro
Vertical Pod Autoscaler (VPA) frees users from the necessity of setting up-to-date resource requests for the containers in their pods. When configured, it will set the requests automatically based on usage and thus allow proper scheduling onto nodes so that appropriate resource amount is available for each pod. It will also maintain ratios between requests and limits that were specified in initial containers configuration.
It can both down-scale pods that are over-requesting resources, and also up-scale pods that are under-requesting resources based on their usage over time.
Autoscaling is configured with a Custom Resource Definition object called VerticalPodAutoscaler. It allows to specify which pods should be vertically autoscaled as well as if/how the resource recommendations are applied.
To enable vertical pod autoscaling on your cluster please follow the installation procedure described below.
Getting Started
See Installation for a guide on installation, followed by a the Quick start guide.
Also refer to the FAQ for more.
Components and Architecture
The Vertical Pod Autoscaler consists of three parts. The recommender, updater and admission-controller. Read more about them on the components page.
Features and Known limitations
You can also read about the features and known limitations of the VPA.
Related links
Directories
¶
| Path | Synopsis |
|---|---|
|
e2e
module
|
|
|
pkg
|
|
|
apis/autoscaling.k8s.io/v1
Package v1 contains definitions of Vertical Pod Autoscaler related objects.
|
Package v1 contains definitions of Vertical Pod Autoscaler related objects. |
|
apis/autoscaling.k8s.io/v1beta1
Package v1beta1 contains definitions of Vertical Pod Autoscaler related objects.
|
Package v1beta1 contains definitions of Vertical Pod Autoscaler related objects. |
|
apis/autoscaling.k8s.io/v1beta2
Package v1beta2 contains definitions of Vertical Pod Autoscaler related objects.
|
Package v1beta2 contains definitions of Vertical Pod Autoscaler related objects. |
|
apis/poc.autoscaling.k8s.io/v1alpha1
Package v1alpha1 contains definitions of Vertical Pod Autoscaler related objects.
|
Package v1alpha1 contains definitions of Vertical Pod Autoscaler related objects. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/autoscaling.k8s.io/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/autoscaling.k8s.io/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/autoscaling.k8s.io/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/autoscaling.k8s.io/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/autoscaling.k8s.io/v1beta2
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/autoscaling.k8s.io/v1beta2/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/poc.autoscaling.k8s.io/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/poc.autoscaling.k8s.io/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
utils/metrics
Package metrics - common code for metrics of all 3 VPA components
|
Package metrics - common code for metrics of all 3 VPA components |
|
utils/metrics/admission
Package admission (aka metrics_admission) - code for metrics of VPA Admission Controller plugin
|
Package admission (aka metrics_admission) - code for metrics of VPA Admission Controller plugin |
|
utils/metrics/quality
Package quality (aka metrics_quality) - code for VPA quality metrics
|
Package quality (aka metrics_quality) - code for VPA quality metrics |
|
utils/metrics/recommender
Package recommender (aka metrics_recommender) - code for metrics of VPA Recommender
|
Package recommender (aka metrics_recommender) - code for metrics of VPA Recommender |
|
utils/metrics/updater
Package updater (aka metrics_updater) - code for metrics of VPA Updater
|
Package updater (aka metrics_updater) - code for metrics of VPA Updater |
|
utils/server
Package server - common code for mux of all 3 VPA components
|
Package server - common code for mux of all 3 VPA components |