Skip to content

Commit 1288c48

Browse files
authored
Merge pull request kubernetes#3232 from bskiba/readme
Bring VPA readme up to date.
2 parents 9a1f3fe + 56e5bec commit 1288c48

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

vertical-pod-autoscaler/README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
## Contents
44
- [Contents](#contents)
5+
- [Intro](#intro)
6+
- [Installation](#installation)
7+
- [Compatibility](#compatibility)
58
- [Notice on removal of v1beta1 version (>=0.5.0)](#notice-on-removal-of-v1beta1-version-050)
69
- [Prerequisites](#prerequisites)
710
- [Install command](#install-command)
@@ -15,7 +18,8 @@
1518
- [Keeping limit proportional to request](#keeping-limit-proportional-to-request)
1619
- [Capping to Limit Range](#capping-to-limit-range)
1720
- [Resource Policy Overriding Limit Range](#resource-policy-overriding-limit-range)
18-
- [Limitations of beta version](#limitations-of-beta-version)
21+
- [Known limitations](#known-limitations)
22+
- [Related links](#related-links)
1923

2024
# Intro
2125

@@ -33,7 +37,7 @@ time.
3337

3438
Autoscaling is configured with a
3539
[Custom Resource Definition object](https://kubernetes.io/docs/concepts/api-extension/custom-resources/)
36-
called [VerticalPodAutoscaler](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1beta2/types.go).
40+
called [VerticalPodAutoscaler](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1/types.go).
3741
It allows to specify which pods should be vertically autoscaled as well as if/how the
3842
resource recommendations are applied.
3943

@@ -42,11 +46,15 @@ procedure described below.
4246

4347
# Installation
4448

45-
The current default version is Vertical Pod Autoscaler 0.5.0
49+
The current default version is Vertical Pod Autoscaler 0.8.0
4650

47-
**NOTE:** since version 0.4 VPA requires at least Kubernetes 1.11 to work (needs certain
48-
Custom Resource Definition capabilities). With older Kubernetes versions we
49-
suggest using the [latest 0.3 version](https://github.com/kubernetes/autoscaler/blob/vpa-release-0.3/vertical-pod-autoscaler/README.md).
51+
### Compatibility
52+
53+
| VPA version | Kubernetes version |
54+
| --- | --- |
55+
| 0.8+ | 1.13+ |
56+
| 0.4 to 0.7 | 1.11+ |
57+
| 0.3.X and lower | 1.7+ |
5058

5159
### Notice on removal of v1beta1 version (>=0.5.0)
5260

@@ -60,7 +68,6 @@ This doc is for installing latest VPA. For instructions on migration from older
6068

6169
### Prerequisites
6270

63-
* VPA version 0.4+ requires Kubernetes 1.11. For older versions see [latest 0.3 version](https://github.com/kubernetes/autoscaler/blob/vpa-release-0.3/vertical-pod-autoscaler/README.md)
6471
* `kubectl` should be connected to the cluster you want to install VPA in.
6572
* The metrics server must be deployed in your cluster. Read more about [Metrics Server](https://github.com/kubernetes-incubator/metrics-server).
6673
* If you are using a GKE Kubernetes cluster, you will need to grant your current Google
@@ -151,7 +158,7 @@ You may need to add more nodes or adjust examples/hamster.yaml to use less CPU.*
151158
### Example VPA configuration
152159

153160
```
154-
apiVersion: autoscaling.k8s.io/v1beta2
161+
apiVersion: autoscaling.k8s.io/v1
155162
kind: VerticalPodAutoscaler
156163
metadata:
157164
name: my-app-vpa
@@ -221,7 +228,7 @@ kubectl delete clusterrolebinding myname-cluster-admin-binding
221228
# Limits control
222229

223230
When setting limits VPA will conform to
224-
[resource policies](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1beta2/types.go#L82).
231+
[resource policies](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1/types.go#L82).
225232
It will maintain limit to request ratio specified for all containers.
226233

227234
VPA will try to cap recommendations between min and max of
@@ -256,8 +263,6 @@ VPA will set RAM request to 2 GB (following the resource policy) and RAM limit t
256263

257264
# Known limitations
258265

259-
## Limitations of beta version
260-
261266
* Updating running pods is an experimental feature of VPA. Whenever VPA updates
262267
the pod resources the pod is recreated, which causes all running containers to
263268
be restarted. The pod may be recreated on a different node.
@@ -281,4 +286,4 @@ VPA will set RAM request to 2 GB (following the resource policy) and RAM limit t
281286
* [Design
282287
proposal](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/autoscaling/vertical-pod-autoscaler.md)
283288
* [API
284-
definition](pkg/apis/autoscaling.k8s.io/v1beta2/types.go)
289+
definition](pkg/apis/autoscaling.k8s.io/v1/types.go)

0 commit comments

Comments
 (0)