Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update the docs to have a blurb for every value in values.yaml #24

Merged
merged 1 commit into from
Mar 27, 2024
Merged

update the docs to have a blurb for every value in values.yaml #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions charts/netmaker/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.11.8
version: 0.11.9

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

maintainers:
- name: "jessebot"
email: "[email protected]"
url: "https://github.com/jessebot/"
- name: "cloudymax"
email: "[email protected]"
url: "https://github.com/cloudymax/"

dependencies:
Expand Down
30 changes: 15 additions & 15 deletions charts/netmaker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# netmaker

![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)
![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)

A Helm chart to run HA Netmaker on Kubernetes

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| jessebot | <[email protected]> | <https://github.com/jessebot/> |
| cloudymax | <[email protected]> | <https://github.com/cloudymax/> |
| jessebot | | <https://github.com/jessebot/> |
| cloudymax | | <https://github.com/cloudymax/> |

## Requirements

Expand All @@ -31,10 +31,10 @@ A Helm chart to run HA Netmaker on Kubernetes
| api.service.targetPort | int | `8081` | targetport for API service |
| api.service.type | string | `"ClusterIP"` | type for netmaker server services |
| dns.enabled | bool | `false` | whether or not to deploy coredns |
| dns.persistence.accessMode | string | `"ReadWriteOnce"` | |
| dns.persistence.accessMode | string | `"ReadWriteOnce"` | access mode of dns persistent volume claim |
| dns.persistence.existingClaim | string | `""` | existingClaim, if not set, defaults to HELM.RELEASE.NAME-dns |
| dns.persistence.storage | string | `"1Gi"` | |
| dns.persistence.storageClassName | string | `""` | |
| dns.persistence.storage | string | `"1Gi"` | size of dns persistent volume claim |
| dns.persistence.storageClassName | string | `""` | storage class of dns persistent volume claim |
| externalDatabase.database | string | `"netmaker"` | postgress db |
| 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 |
| externalDatabase.host | string | `"external.postgres.url"` | postgres host |
Expand All @@ -47,13 +47,13 @@ A Helm chart to run HA Netmaker on Kubernetes
| image.repository | string | `"gravitl/netmaker"` | The image repo to pull Netmaker image from |
| mq.affinity | object | `{}` | optional affinity settings for mqtt |
| 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 |
| mq.generateCert | bool | `false` | |
| mq.generateCert | bool | `false` | generate a self signed certmanager cert |
| mq.ingress.annotations | object | `{}` | annotations for the mqtt ingress object |
| mq.ingress.className | string | `"nginx"` | |
| mq.ingress.enabled | bool | `true` | attempts to configure ingress if true |
| mq.ingress.host | string | `"broker.cluster.local"` | hostname for mqtt ingress |
| mq.ingress.tls | list | `[]` | ingress tls list |
| mq.password | string | `""` | |
| mq.password | string | `""` | mqtt password, ignored if mq.existingSecret is set |
| mq.replicas | int | `1` | how many MQTT replicas to create |
| mq.service.port | int | `443` | port for MQTT service |
| mq.service.targetPort | int | `8883` | Target port for MQTT service |
Expand Down Expand Up @@ -93,17 +93,17 @@ A Helm chart to run HA Netmaker on Kubernetes
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
| serviceAccount.name | string | `""` | Name of SA to use. If not set and create is true, a name is generated using the fullname template |
| setIpForwarding.enabled | bool | `true` | |
| shared_data.persistence.accessMode | string | `"ReadWriteMany"` | |
| shared_data.persistence.accessMode | string | `"ReadWriteMany"` | access mode of shared data persistent volume claim |
| shared_data.persistence.existingClaim | string | `""` | name of existing PVC claim to use. if set, storageClassName is ignored |
| shared_data.persistence.storage | string | `"128Mi"` | |
| shared_data.persistence.storageClassName | string | `""` | |
| shared_data.persistence.storage | string | `"128Mi"` | access mode of shared data persistent volume claim |
| shared_data.persistence.storageClassName | string | `""` | storage class of shared data persistent volume claim |
| tolerations | object | `{}` | optional tolerations settings for netmaker |
| turn.apiHost | string | `""` | |
| turn.apiHost | string | `""` | turn server api hostname |
| turn.enabled | bool | `false` | use an external turn server |
| 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 |
| turn.host | string | `""` | |
| turn.password | string | `""` | |
| turn.username | string | `""` | |
| turn.host | string | `""` | turn server hostname |
| turn.password | string | `""` | turn server password, ignored if turn.existingSecret is set |
| turn.username | string | `""` | turn server username, ignored if turn.existingSecret is set |
| ui.ingress.annotations | object | `{}` | annotations for the netmaker UI ingress object |
| ui.ingress.className | string | `"nginx"` | UI ingress className |
| ui.ingress.enabled | bool | `true` | attempts to configure ingress if true |
Expand Down
12 changes: 12 additions & 0 deletions charts/netmaker/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ ui:
mq:
# -- how many MQTT replicas to create
replicas: 1
# -- generate a self signed certmanager cert
generateCert: false
# -- optional tolerations settings for mqtt
tolerations: {}
Expand All @@ -169,6 +170,7 @@ mq:
# values:
# - "true"
username: netmaker
# -- mqtt password, ignored if mq.existingSecret is set
password: ''
# -- 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
Expand Down Expand Up @@ -205,16 +207,22 @@ dns:
persistence:
# -- existingClaim, if not set, defaults to HELM.RELEASE.NAME-dns
existingClaim: ''
# -- size of dns persistent volume claim
storage: 1Gi
# -- storage class of dns persistent volume claim
storageClassName: ""
# -- access mode of dns persistent volume claim
accessMode: ReadWriteOnce

shared_data:
persistence:
# -- name of existing PVC claim to use. if set, storageClassName is ignored
existingClaim: ""
# -- access mode of shared data persistent volume claim
accessMode: "ReadWriteMany"
# -- storage class of shared data persistent volume claim
storageClassName: ""
# -- access mode of shared data persistent volume claim
storage: 128Mi

setIpForwarding:
Expand Down Expand Up @@ -263,9 +271,13 @@ externalDatabase:
turn:
# -- use an external turn server
enabled: false
# -- turn server hostname
host: ""
# -- turn server api hostname
apiHost: ""
# -- turn server username, ignored if turn.existingSecret is set
username: ""
# -- turn server password, ignored if turn.existingSecret is set
password: ""
# -- existing secret with turn server info. Must have the following keys:
# TURN_SERVER_HOST, TURN_SERVER_API_HOST, TURN_PORT, TURN_USERNAME, TURN_PASSWORD
Expand Down
Loading