Skip to content

Commit 8bc11d9

Browse files
committed
doc(README): use helm-docs
Signed-off-by: Toni Tauro <toni.tauro@adfinis.com>
1 parent c376de3 commit 8bc11d9

3 files changed

Lines changed: 35 additions & 0 deletions

File tree

.pre-commit-config.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
repos:
2+
- repo: https://github.com/norwoodj/helm-docs
3+
rev: v1.10.0
4+
hooks:
5+
- id: helm-docs
26
- repo: https://github.com/TekWizely/pre-commit-golang
37
rev: v1.0.0-beta.5
48
hooks:
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# cloudscale-slb-controller
2+
3+
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.2.0](https://img.shields.io/badge/AppVersion-v0.2.0-informational?style=flat-square)
4+
5+
Kubernetes service load-balancer-controller for cloudscale resources
6+
7+
## Source Code
8+
9+
* <https://github.com/linkyard/cloudscale-slb-controller.git>
10+
11+
## Values
12+
13+
| Key | Type | Default | Description |
14+
|-----|------|---------|-------------|
15+
| cloudscale.token | object | `{"value":"SECRET"}` | cloudscale token to use |
16+
| controller.controllerId | string | `""` | controllerID to use |
17+
| controller.cpuRequests | string | `"250m"` | cpu requests for controller |
18+
| controller.image | object | `{"pullPolicy":"IfNotPresent","repository":"ghcr.io/linkyard/cloudscale-slb-controller","tag":""}` | controller image to use |
19+
| controller.ipLimit | string | `"10"` | ipLimit for controller |
20+
| controller.logLevel | string | `"Info"` | loglevel for controller |
21+
| controller.memoryRequests | string | `"128Mi"` | memory requests for controller |
22+
23+
----------------------------------------------
24+
Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
11
---
22
cloudscale:
3+
# -- cloudscale token to use
34
token:
45
value: "SECRET"
56
# existingSecret: "mysecretname"
67

78
controller:
9+
# -- controller image to use
810
image:
911
repository: ghcr.io/linkyard/cloudscale-slb-controller
1012
pullPolicy: IfNotPresent
1113
tag: ""
14+
# -- ipLimit for controller
1215
ipLimit: "10"
16+
# -- loglevel for controller
1317
logLevel: "Info"
18+
# -- controllerID to use
1419
controllerId: ""
20+
# -- cpu requests for controller
1521
cpuRequests: 250m
22+
# -- memory requests for controller
1623
memoryRequests: 128Mi

0 commit comments

Comments
 (0)