Skip to content

Commit 7107663

Browse files
committed
Add README.md.gotmpl
Signed-off-by: Omer Aplatony <[email protected]>
1 parent 17f1b0b commit 7107663

File tree

2 files changed

+74
-5
lines changed

2 files changed

+74
-5
lines changed
Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,62 @@
1-
# Vertical Pod Autoscaler Helm Chart
1+
# vertical-pod-autoscaler
22

3-
WARNING: This chart is currently under development
3+
WARNING: This chart is currently under development and is not ready for production use.
4+
5+
Automatically adjust resources for your workloads
6+
7+
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square)
8+
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
9+
![AppVersion: 1.5.0](https://img.shields.io/badge/AppVersion-1.5.0-informational?style=flat-square)
410

511
## Introduction
12+
The Vertical Pod Autoscaler (VPA) automatically adjusts the CPU and memory resource requests of pods to match their actual resource utilization.
13+
14+
## Maintainers
615

7-
This chart bootstraps a Vertical Pod Autoscaler (VPA) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
16+
| Name | Email | Url |
17+
| ---- | ------ | --- |
18+
| adrianmoisey | <[email protected]> | |
19+
| omerap12 | <[email protected]> | |
820

9-
## Development Status
21+
## Values
1022

11-
This Helm chart is a work in progress and is not ready for production use. Please check back later for updates.
23+
| Key | Type | Default | Description |
24+
|-----|------|---------|-------------|
25+
| admissionController.enabled | bool | `true` | |
26+
| admissionController.extraArgs | list | `[]` | |
27+
| admissionController.extraEnv | list | `[]` | |
28+
| admissionController.image.pullPolicy | string | `"IfNotPresent"` | |
29+
| admissionController.image.repository | string | `"registry.k8s.io/autoscaling/vpa-admission-controller"` | |
30+
| admissionController.image.tag | string | `nil` | |
31+
| admissionController.nodeSelector | object | `{}` | |
32+
| admissionController.podAnnotations | object | `{}` | |
33+
| admissionController.podLabels | object | `{}` | |
34+
| admissionController.replicas | int | `1` | |
35+
| admissionController.resources.limits.cpu | string | `"200m"` | |
36+
| admissionController.resources.limits.memory | string | `"500Mi"` | |
37+
| admissionController.resources.requests.cpu | string | `"50m"` | |
38+
| admissionController.resources.requests.memory | string | `"200Mi"` | |
39+
| admissionController.service.annotations | object | `{}` | |
40+
| admissionController.service.name | string | `"vpa-webhook"` | |
41+
| admissionController.service.ports[0].port | int | `443` | |
42+
| admissionController.service.ports[0].protocol | string | `"TCP"` | |
43+
| admissionController.service.ports[0].targetPort | int | `8000` | |
44+
| admissionController.serviceAccount.annotations | object | `{}` | |
45+
| admissionController.serviceAccount.create | bool | `true` | |
46+
| admissionController.serviceAccount.labels | object | `{}` | |
47+
| admissionController.tls.caCert | string | `""` | |
48+
| admissionController.tls.cert | string | `""` | |
49+
| admissionController.tls.existingSecret | string | `""` | |
50+
| admissionController.tls.key | string | `""` | |
51+
| admissionController.tls.secretName | string | `"vpa-tls-certs"` | |
52+
| admissionController.volumeMounts[0].mountPath | string | `"/etc/tls-certs"` | |
53+
| admissionController.volumeMounts[0].name | string | `"tls-certs"` | |
54+
| admissionController.volumeMounts[0].readOnly | bool | `true` | |
55+
| admissionController.volumes[0].name | string | `"tls-certs"` | |
56+
| admissionController.volumes[0].secret.defaultMode | int | `420` | |
57+
| admissionController.volumes[0].secret.secretName | string | `"vpa-tls-certs"` | |
58+
| commonLabels | object | `{}` | |
59+
| fullnameOverride | string | `nil` | |
60+
| imagePullSecrets | list | `[]` | |
61+
| nameOverride | string | `nil` | |
62+
| rbac.create | bool | `true` | |
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{{ template "chart.header" . }}
2+
3+
WARNING: This chart is currently under development and is not ready for production use.
4+
5+
{{ template "chart.description" . }}
6+
7+
{{ template "chart.versionBadge" . }}
8+
{{ template "chart.typeBadge" . }}
9+
{{ template "chart.appVersionBadge" . }}
10+
11+
## Introduction
12+
The Vertical Pod Autoscaler (VPA) automatically adjusts the CPU and memory resource requests of pods to match their actual resource utilization.
13+
14+
{{ template "chart.maintainersSection" . }}
15+
16+
{{ template "chart.requirementsSection" . }}
17+
18+
{{ template "chart.valuesSection" . }}

0 commit comments

Comments
 (0)