Skip to content

Commit 4ba6c99

Browse files
committed
📝 docs
modified: README.md
1 parent 37e778c commit 4ba6c99

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
![alt text](/assets/example.png)
33

44
**kube-reqsizer** is a kubernetes controller that will measure the usage of pods over time and reduce their requests based on the average usage.
5+
## Deploy - Helm
56

7+
```bash
8+
helm install \
9+
https://github.com/jatalocks/kube-reqsizer/releases/download/kube-reqsizer-0.4.0/kube-reqsizer-0.4.0.tgz
10+
```
611
## Description
712

813
Kube-reqsizer has two primary custom flags:
@@ -32,11 +37,7 @@ Disclaimer:
3237

3338
`sample-size` is the amount of data-points the controller will store in cache before constructing an average for the pod. After a requests resizing, the cache will clean itself and a new average will be calculated based on the sample size. If `min-seconds` has not yet passed since the pod has last been supposed to be sample-reconciled, the controller will keep sampling the pod until `min-seconds` have been reached and only then zero the sample and restart from cache.
3439

35-
## Deploy - Helm
3640

37-
```bash
38-
helm install https://github.com/jatalocks/kube-reqsizer/releases/download/kube-reqsizer-0.4.0/kube-reqsizer-0.4.0.tgz
39-
```
4041
# Development
4142
## Getting Started
4243
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.

0 commit comments

Comments
 (0)