Skip to content

Commit c32864d

Browse files
hiddenmartenhiddenmarten
authored
[102] Slightly update default template and add some comments (#230)
1 parent 3d90173 commit c32864d

File tree

4 files changed

+151
-63
lines changed

4 files changed

+151
-63
lines changed

‎charts/etcd-operator/README.md

Lines changed: 38 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,54 @@
11
# etcd-operator
22

3-
![Version: 0.0.0](https://img.shields.io/badge/Version-0.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
3+
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
44

55
## Values
66

77
| Key | Type | Default | Description |
88
|-----|------|---------|-------------|
9-
| affinity | object | `{}` | |
9+
| affinity | object | `{}` | ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity |
1010
| etcdOperator.args[0] | string | `"--health-probe-bind-address=:8081"` | |
1111
| etcdOperator.args[1] | string | `"--metrics-bind-address=127.0.0.1:8080"` | |
1212
| etcdOperator.args[2] | string | `"--leader-elect"` | |
13-
| etcdOperator.envVars | object | `{}` | |
14-
| etcdOperator.image.pullPolicy | string | `"IfNotPresent"` | |
15-
| etcdOperator.image.repository | string | `"ghcr.io/aenix-io/etcd-operator"` | |
16-
| etcdOperator.image.tag | string | `""` | |
17-
| etcdOperator.livenessProbe.httpGet.path | string | `"/healthz"` | |
18-
| etcdOperator.livenessProbe.httpGet.port | int | `8081` | |
19-
| etcdOperator.livenessProbe.initialDelaySeconds | int | `15` | |
20-
| etcdOperator.livenessProbe.periodSeconds | int | `20` | |
21-
| etcdOperator.readinessProbe.httpGet.path | string | `"/readyz"` | |
22-
| etcdOperator.readinessProbe.httpGet.port | int | `8081` | |
23-
| etcdOperator.readinessProbe.initialDelaySeconds | int | `5` | |
24-
| etcdOperator.readinessProbe.periodSeconds | int | `10` | |
25-
| etcdOperator.resources.limits.cpu | string | `"500m"` | |
26-
| etcdOperator.resources.limits.memory | string | `"128Mi"` | |
27-
| etcdOperator.resources.requests.cpu | string | `"100m"` | |
28-
| etcdOperator.resources.requests.memory | string | `"64Mi"` | |
29-
| etcdOperator.securityContext.allowPrivilegeEscalation | bool | `false` | |
30-
| etcdOperator.securityContext.capabilities.drop[0] | string | `"ALL"` | |
31-
| etcdOperator.service.port | int | `9443` | |
32-
| etcdOperator.service.type | string | `"ClusterIP"` | |
33-
| fullnameOverride | string | `""` | |
13+
| etcdOperator.envVars | object | `{}` | Empty environment variables section |
14+
| etcdOperator.image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
15+
| etcdOperator.image.repository | string | `"ghcr.io/aenix-io/etcd-operator"` | Image repository |
16+
| etcdOperator.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
17+
| etcdOperator.livenessProbe.httpGet.path | string | `"/healthz"` | Healthcheck liveness probe path |
18+
| etcdOperator.livenessProbe.httpGet.port | int | `8081` | Healthcheck port |
19+
| etcdOperator.livenessProbe.initialDelaySeconds | int | `15` | ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes |
20+
| etcdOperator.livenessProbe.periodSeconds | int | `20` | ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes |
21+
| etcdOperator.readinessProbe.httpGet.path | string | `"/readyz"` | Healthcheck readiness probe path |
22+
| etcdOperator.readinessProbe.httpGet.port | int | `8081` | Healthcheck port |
23+
| etcdOperator.readinessProbe.initialDelaySeconds | int | `5` | ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes |
24+
| etcdOperator.readinessProbe.periodSeconds | int | `10` | ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes |
25+
| etcdOperator.resources | object | `{"limits":{"cpu":"500m","memory":"128Mi"},"requests":{"cpu":"100m","memory":"64Mi"}}` | ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
26+
| etcdOperator.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]}}` | ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
27+
| etcdOperator.service.port | int | `9443` | Service port |
28+
| etcdOperator.service.type | string | `"ClusterIP"` | Service type |
29+
| fullnameOverride | string | `""` | Override a full name of helm release |
3430
| imagePullSecrets | list | `[]` | |
3531
| kubeRbacProxy.args[0] | string | `"--secure-listen-address=0.0.0.0:8443"` | |
3632
| kubeRbacProxy.args[1] | string | `"--upstream=http://127.0.0.1:8080/"` | |
3733
| kubeRbacProxy.args[2] | string | `"--logtostderr=true"` | |
3834
| kubeRbacProxy.args[3] | string | `"--v=0"` | |
39-
| kubeRbacProxy.image.pullPolicy | string | `"IfNotPresent"` | |
40-
| kubeRbacProxy.image.repository | string | `"gcr.io/kubebuilder/kube-rbac-proxy"` | |
41-
| kubeRbacProxy.image.tag | string | `"v0.16.0"` | |
42-
| kubeRbacProxy.livenessProbe | object | `{}` | |
43-
| kubeRbacProxy.readinessProbe | object | `{}` | |
44-
| kubeRbacProxy.resources.limits.cpu | string | `"500m"` | |
45-
| kubeRbacProxy.resources.limits.memory | string | `"128Mi"` | |
46-
| kubeRbacProxy.resources.requests.cpu | string | `"100m"` | |
47-
| kubeRbacProxy.resources.requests.memory | string | `"64Mi"` | |
48-
| kubeRbacProxy.securityContext.allowPrivilegeEscalation | bool | `false` | |
49-
| kubeRbacProxy.securityContext.capabilities.drop[0] | string | `"ALL"` | |
50-
| kubeRbacProxy.service.port | int | `8443` | |
51-
| kubeRbacProxy.service.type | string | `"ClusterIP"` | |
52-
| kubernetesClusterDomain | string | `"cluster.local"` | |
53-
| nameOverride | string | `""` | |
54-
| nodeSelector | object | `{}` | |
55-
| podAnnotations | object | `{}` | |
56-
| podLabels | object | `{}` | |
57-
| podSecurityContext | object | `{}` | |
58-
| replicaCount | int | `1` | |
59-
| securityContext.runAsNonRoot | bool | `true` | |
60-
| serviceAccount.annotations | object | `{}` | |
61-
| serviceAccount.create | bool | `true` | |
62-
| tolerations | list | `[]` | |
35+
| kubeRbacProxy.image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
36+
| kubeRbacProxy.image.repository | string | `"gcr.io/kubebuilder/kube-rbac-proxy"` | Image repository |
37+
| kubeRbacProxy.image.tag | string | `"v0.16.0"` | Version of image |
38+
| kubeRbacProxy.livenessProbe | object | `{}` | https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ |
39+
| kubeRbacProxy.readinessProbe | object | `{}` | https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ |
40+
| kubeRbacProxy.resources | object | `{"limits":{"cpu":"250m","memory":"128Mi"},"requests":{"cpu":"100m","memory":"64Mi"}}` | ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
41+
| kubeRbacProxy.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]}}` | ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
42+
| kubeRbacProxy.service.port | int | `8443` | Service port |
43+
| kubeRbacProxy.service.type | string | `"ClusterIP"` | Service type |
44+
| kubernetesClusterDomain | string | `"cluster.local"` | Kubernetes cluster domain prefix |
45+
| nameOverride | string | `""` | Override a name of helm release |
46+
| nodeSelector | object | `{}` | ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ |
47+
| podAnnotations | object | `{}` | ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ |
48+
| podLabels | object | `{}` | ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
49+
| podSecurityContext | object | `{}` | ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
50+
| replicaCount | int | `1` | Count of pod replicas |
51+
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
52+
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
53+
| tolerations | list | `[]` | ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ |
6354

‎charts/etcd-operator/README.md.gotmpl

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{{ template "chart.header" . }}
2+
3+
{{ template "chart.deprecationWarning" . }}
4+
5+
{{ template "chart.typeBadge" . }}
6+
7+
{{ template "chart.description" . }}
8+
9+
{{ template "chart.homepageLine" . }}
10+
11+
{{ template "chart.maintainersSection" . }}
12+
13+
{{ template "chart.sourcesSection" . }}
14+
15+
{{ template "chart.requirementsSection" . }}
16+
17+
{{ template "chart.valuesSection" . }}
18+
19+
{{ template "helm-docs.versionFooter" . }}

‎charts/etcd-operator/values.schema.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -256,14 +256,6 @@
256256
"replicaCount": {
257257
"type": "integer"
258258
},
259-
"securityContext": {
260-
"properties": {
261-
"runAsNonRoot": {
262-
"type": "boolean"
263-
}
264-
},
265-
"type": "object"
266-
},
267259
"serviceAccount": {
268260
"properties": {
269261
"annotations": {

‎charts/etcd-operator/values.yaml

Lines changed: 94 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,184 @@
11
etcdOperator:
2+
23
image:
4+
5+
# -- Image repository
36
repository: ghcr.io/aenix-io/etcd-operator
7+
8+
# -- Image pull policy
49
pullPolicy: IfNotPresent
5-
# Overrides the image tag whose default is the chart appVersion.
10+
11+
# -- Overrides the image tag whose default is the chart appVersion.
612
tag: ""
13+
714
args:
815
- --health-probe-bind-address=:8081
916
- --metrics-bind-address=127.0.0.1:8080
1017
- --leader-elect
18+
1119
service:
20+
21+
# -- Service type
1222
type: ClusterIP
23+
24+
# -- Service port
1325
port: 9443
26+
27+
# -- Empty environment variables section
1428
envVars: {}
29+
1530
livenessProbe:
31+
1632
httpGet:
33+
34+
# -- Healthcheck liveness probe path
1735
path: /healthz
36+
37+
# -- Healthcheck port
1838
port: 8081
39+
40+
# -- ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes
1941
initialDelaySeconds: 15
42+
43+
# -- ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes
2044
periodSeconds: 20
45+
2146
readinessProbe:
47+
2248
httpGet:
49+
50+
# -- Healthcheck readiness probe path
2351
path: /readyz
52+
53+
# -- Healthcheck port
2454
port: 8081
55+
56+
# -- ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes
2557
initialDelaySeconds: 5
58+
59+
# -- ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes
2660
periodSeconds: 10
61+
62+
# -- ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
2763
resources:
64+
2865
limits:
66+
2967
cpu: 500m
68+
3069
memory: 128Mi
70+
3171
requests:
72+
3273
cpu: 100m
74+
3375
memory: 64Mi
76+
77+
# -- ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
3478
securityContext:
79+
3580
allowPrivilegeEscalation: false
81+
3682
capabilities:
83+
3784
drop:
3885
- ALL
3986

4087
kubeRbacProxy:
88+
4189
image:
90+
91+
# -- Image repository
4292
repository: gcr.io/kubebuilder/kube-rbac-proxy
93+
94+
# -- Image pull policy
4395
pullPolicy: IfNotPresent
96+
97+
# -- Version of image
4498
tag: v0.16.0
99+
45100
args:
46101
- --secure-listen-address=0.0.0.0:8443
47102
- --upstream=http://127.0.0.1:8080/
48103
- --logtostderr=true
49104
- --v=0
105+
50106
service:
107+
108+
# -- Service type
51109
type: ClusterIP
110+
111+
# -- Service port
52112
port: 8443
113+
114+
# -- https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
53115
livenessProbe: {}
116+
117+
# -- https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
54118
readinessProbe: {}
119+
120+
# -- ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
55121
resources:
122+
56123
limits:
57-
cpu: 500m
124+
125+
cpu: 250m
126+
58127
memory: 128Mi
128+
59129
requests:
130+
60131
cpu: 100m
132+
61133
memory: 64Mi
134+
135+
# -- ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
62136
securityContext:
137+
63138
allowPrivilegeEscalation: false
139+
64140
capabilities:
141+
65142
drop:
66-
- ALL
143+
- ALL
67144

145+
# -- Kubernetes cluster domain prefix
68146
kubernetesClusterDomain: cluster.local
69147

148+
# -- Count of pod replicas
70149
replicaCount: 1
71150

72151
imagePullSecrets: []
73152

153+
# -- Override a name of helm release
74154
nameOverride: ""
75155

156+
# -- Override a full name of helm release
76157
fullnameOverride: ""
77158

78159
serviceAccount:
79-
# Specifies whether a service account should be created
160+
161+
# -- Specifies whether a service account should be created
80162
create: true
81-
# Annotations to add to the service account
163+
164+
# -- Annotations to add to the service account
82165
annotations: {}
83166

167+
# -- ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
84168
podAnnotations: {}
85169

170+
# -- ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
86171
podLabels: {}
87172

173+
# -- ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
88174
podSecurityContext: {}
89175
# fsGroup: 2000
90176

91-
securityContext:
92-
runAsNonRoot: true
93-
177+
# -- ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
94178
nodeSelector: {}
95179

180+
# -- ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/
96181
tolerations: []
97182

183+
# -- ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity
98184
affinity: {}

0 commit comments

Comments
 (0)