kubernetes
/
autoscaler
mirror of https://github.com/kubernetes/autoscaler.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(README): Updating / adding Helm chart docs 

Signed-off-by: Scott Crooks <scott.crooks@gmail.com>
This commit is contained in:
Scott Crooks 2020-07-22 19:42:43 +02:00
parent d46a1c9916
commit 98f38f2916
No known key found for this signature in database
GPG Key ID: 1013BA3530FFE8DA
2 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -15,6 +15,8 @@ amount of CPU and memory requested by pods running in the Kubernetes Cluster. Cu
[Addon Resizer](https://github.com/kubernetes/autoscaler/tree/master/addon-resizer) - a simplified version of vertical pod autoscaler that modifies
resource requests of a deployment based on the number of nodes in the Kubernetes Cluster. Current state - beta.
[Charts](https://github.com/kubernetes/autoscaler/tree/master/charts) - Supported Helm charts for components above.
## Contact Info
Interested in autoscaling? Want to talk? Have questions, concerns or great ideas?

34
charts/README.md Normal file
View File

@ -0,0 +1,34 @@
# charts
The Helm charts for the Autoscaler project reside within this folder. If making changes to the Helm charts, make sure you follow the instructions below for the pre-commit checks.
## Pre-commit hooks
This Helm repository has pre-commit hooks for Helm specific needs:
* Makes sure all charts pass a `helm lint` check.
* Updates the `README.md` file of all charts based on comments in that chart's `values.yaml` file.
### Install `pre-commit` binary
The binary for `pre-commit` can be installed via Homebrew:
```shell
$ brew install pre-commit
```
### Install git hooks
After the `pre-commit` binary is installed, go to this repository's directory, and run the following command to install the git hook:
```shell
$ pre-commit install
```
### Install hook dependencies
The pre-commit hooks themselves call binaries under the hood; they can be installed via the following command:
```shell
$ brew install helm norwoodj/tap/helm-docs
```