Skip to content

Commit f249d49

Browse files
jessebotjessebot
authored
Merge pull request #24 from small-hack/update-docs
update the docs to have a blurb for every value in values.yaml
2 parents 4f87f78 + de8ecac commit f249d49

File tree

3 files changed

+28
-18
lines changed

3 files changed

+28
-18
lines changed

‎charts/netmaker/Chart.yaml‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type: application
1515
# This is the chart version. This version number should be incremented each time you make changes
1616
# to the chart and its templates, including the app version.
1717
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 0.11.8
18+
version: 0.11.9
1919

2020
# This is the version number of the application being deployed. This version number should be
2121
# incremented each time you make changes to the application. Versions are not expected to
@@ -25,10 +25,8 @@ appVersion: "v0.23.0"
2525

2626
maintainers:
2727
- name: "jessebot"
28-
email: "jessebot@linux.com"
2928
url: "https://github.com/jessebot/"
3029
- name: "cloudymax"
31-
email: "emax@cloudydev.net"
3230
url: "https://github.com/cloudymax/"
3331

3432
dependencies:

‎charts/netmaker/README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# netmaker
22

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

55
A Helm chart to run HA Netmaker on Kubernetes
66

77
## Maintainers
88

99
| Name | Email | Url |
1010
| ---- | ------ | --- |
11-
| jessebot | <jessebot@linux.com> | <https://github.com/jessebot/> |
12-
| cloudymax | <emax@cloudydev.net> | <https://github.com/cloudymax/> |
11+
| jessebot | | <https://github.com/jessebot/> |
12+
| cloudymax | | <https://github.com/cloudymax/> |
1313

1414
## Requirements
1515

@@ -31,10 +31,10 @@ A Helm chart to run HA Netmaker on Kubernetes
3131
| api.service.targetPort | int | `8081` | targetport for API service |
3232
| api.service.type | string | `"ClusterIP"` | type for netmaker server services |
3333
| dns.enabled | bool | `false` | whether or not to deploy coredns |
34-
| dns.persistence.accessMode | string | `"ReadWriteOnce"` | |
34+
| dns.persistence.accessMode | string | `"ReadWriteOnce"` | access mode of dns persistent volume claim |
3535
| dns.persistence.existingClaim | string | `""` | existingClaim, if not set, defaults to HELM.RELEASE.NAME-dns |
36-
| dns.persistence.storage | string | `"1Gi"` | |
37-
| dns.persistence.storageClassName | string | `""` | |
36+
| dns.persistence.storage | string | `"1Gi"` | size of dns persistent volume claim |
37+
| dns.persistence.storageClassName | string | `""` | storage class of dns persistent volume claim |
3838
| externalDatabase.database | string | `"netmaker"` | postgress db |
3939
| externalDatabase.existingSecret | string | `""` | use existing secret for netmaker db credentials, must have the following keys: SQL_PASS, SQL_HOST, SQL_PORT, SQL_USER, SQL_DB |
4040
| externalDatabase.host | string | `"external.postgres.url"` | postgres host |
@@ -47,13 +47,13 @@ A Helm chart to run HA Netmaker on Kubernetes
4747
| image.repository | string | `"gravitl/netmaker"` | The image repo to pull Netmaker image from |
4848
| mq.affinity | object | `{}` | optional affinity settings for mqtt |
4949
| mq.existingSecret | string | `""` | name of an existing secret to use for mq password. If set, ignores mq.password, mq.username secret keys must be: MQ_PASSWORD, MQ_USERNAME |
50-
| mq.generateCert | bool | `false` | |
50+
| mq.generateCert | bool | `false` | generate a self signed certmanager cert |
5151
| mq.ingress.annotations | object | `{}` | annotations for the mqtt ingress object |
5252
| mq.ingress.className | string | `"nginx"` | |
5353
| mq.ingress.enabled | bool | `true` | attempts to configure ingress if true |
5454
| mq.ingress.host | string | `"broker.cluster.local"` | hostname for mqtt ingress |
5555
| mq.ingress.tls | list | `[]` | ingress tls list |
56-
| mq.password | string | `""` | |
56+
| mq.password | string | `""` | mqtt password, ignored if mq.existingSecret is set |
5757
| mq.replicas | int | `1` | how many MQTT replicas to create |
5858
| mq.service.port | int | `443` | port for MQTT service |
5959
| mq.service.targetPort | int | `8883` | Target port for MQTT service |
@@ -93,17 +93,17 @@ A Helm chart to run HA Netmaker on Kubernetes
9393
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
9494
| serviceAccount.name | string | `""` | Name of SA to use. If not set and create is true, a name is generated using the fullname template |
9595
| setIpForwarding.enabled | bool | `true` | |
96-
| shared_data.persistence.accessMode | string | `"ReadWriteMany"` | |
96+
| shared_data.persistence.accessMode | string | `"ReadWriteMany"` | access mode of shared data persistent volume claim |
9797
| shared_data.persistence.existingClaim | string | `""` | name of existing PVC claim to use. if set, storageClassName is ignored |
98-
| shared_data.persistence.storage | string | `"128Mi"` | |
99-
| shared_data.persistence.storageClassName | string | `""` | |
98+
| shared_data.persistence.storage | string | `"128Mi"` | access mode of shared data persistent volume claim |
99+
| shared_data.persistence.storageClassName | string | `""` | storage class of shared data persistent volume claim |
100100
| tolerations | object | `{}` | optional tolerations settings for netmaker |
101-
| turn.apiHost | string | `""` | |
101+
| turn.apiHost | string | `""` | turn server api hostname |
102102
| turn.enabled | bool | `false` | use an external turn server |
103103
| turn.existingSecret | string | `""` | existing secret with turn server info. Must have the following keys: TURN_SERVER_HOST, TURN_SERVER_API_HOST, TURN_PORT, TURN_USERNAME, TURN_PASSWORD |
104-
| turn.host | string | `""` | |
105-
| turn.password | string | `""` | |
106-
| turn.username | string | `""` | |
104+
| turn.host | string | `""` | turn server hostname |
105+
| turn.password | string | `""` | turn server password, ignored if turn.existingSecret is set |
106+
| turn.username | string | `""` | turn server username, ignored if turn.existingSecret is set |
107107
| ui.ingress.annotations | object | `{}` | annotations for the netmaker UI ingress object |
108108
| ui.ingress.className | string | `"nginx"` | UI ingress className |
109109
| ui.ingress.enabled | bool | `true` | attempts to configure ingress if true |

‎charts/netmaker/values.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ ui:
155155
mq:
156156
# -- how many MQTT replicas to create
157157
replicas: 1
158+
# -- generate a self signed certmanager cert
158159
generateCert: false
159160
# -- optional tolerations settings for mqtt
160161
tolerations: {}
@@ -169,6 +170,7 @@ mq:
169170
# values:
170171
# - "true"
171172
username: netmaker
173+
# -- mqtt password, ignored if mq.existingSecret is set
172174
password: ''
173175
# -- name of an existing secret to use for mq password. If set, ignores mq.password, mq.username
174176
# secret keys must be: MQ_PASSWORD, MQ_USERNAME
@@ -205,16 +207,22 @@ dns:
205207
persistence:
206208
# -- existingClaim, if not set, defaults to HELM.RELEASE.NAME-dns
207209
existingClaim: ''
210+
# -- size of dns persistent volume claim
208211
storage: 1Gi
212+
# -- storage class of dns persistent volume claim
209213
storageClassName: ""
214+
# -- access mode of dns persistent volume claim
210215
accessMode: ReadWriteOnce
211216

212217
shared_data:
213218
persistence:
214219
# -- name of existing PVC claim to use. if set, storageClassName is ignored
215220
existingClaim: ""
221+
# -- access mode of shared data persistent volume claim
216222
accessMode: "ReadWriteMany"
223+
# -- storage class of shared data persistent volume claim
217224
storageClassName: ""
225+
# -- access mode of shared data persistent volume claim
218226
storage: 128Mi
219227

220228
setIpForwarding:
@@ -263,9 +271,13 @@ externalDatabase:
263271
turn:
264272
# -- use an external turn server
265273
enabled: false
274+
# -- turn server hostname
266275
host: ""
276+
# -- turn server api hostname
267277
apiHost: ""
278+
# -- turn server username, ignored if turn.existingSecret is set
268279
username: ""
280+
# -- turn server password, ignored if turn.existingSecret is set
269281
password: ""
270282
# -- existing secret with turn server info. Must have the following keys:
271283
# TURN_SERVER_HOST, TURN_SERVER_API_HOST, TURN_PORT, TURN_USERNAME, TURN_PASSWORD

0 commit comments

Comments
 (0)