yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(helm-chart): revised software name to match conventioned name 

fix(helm-chart): added missing new-line from resource templates
This commit is contained in:
Fernando Almeida 2022-01-26 09:01:25 +00:00
parent 73c452c64d
commit b91dc1c13d
7 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
deploy/charts/emqx/README.md
View File

@ -1,5 +1,5 @@
# Introduction # Introduction
This chart bootstraps an [EMQx](https://www.emqx.io/) deployment on a [Kubernetes](https://kubernetes.io/) (K8s) cluster using the [Helm](https://helm.sh/) package manager. This chart bootstraps an [EMQ X](https://www.emqx.io/) deployment on a [Kubernetes](https://kubernetes.io/) (K8s) cluster using the [Helm](https://helm.sh/) package manager.
# Prerequisites # Prerequisites
+ [Kubernetes](https://kubernetes.io/) 1.6+ + [Kubernetes](https://kubernetes.io/) 1.6+
@ -30,8 +30,8 @@ $ helm del my-emqx
# Configuration # Configuration
The following sections describe the configurable parameters of the chart and their default values. The following sections describe the configurable parameters of the chart and their default values.
## K8s-specific ## [K8s]((https://kubernetes.io/)) specific settings
The following table lists the configurable K8s parameters of the [EMQx](https://www.emqx.io/) chart and their default values. The following table lists the configurable K8s parameters of the [EMQ X](https://www.emqx.io/) chart and their default values.
Parameter | Description | Default Value Parameter | Description | Default Value
--- | --- | --- --- | --- | ---
`replicaCount` | It is recommended to have odd number of nodes in a cluster, otherwise the emqx cluster cannot be automatically healed in case of net-split. | `3` `replicaCount` | It is recommended to have odd number of nodes in a cluster, otherwise the emqx cluster cannot be automatically healed in case of net-split. | `3`
@ -91,8 +91,8 @@ Parameter | Description | Default Value
`extraVolumes` | Additional container volumes (eg. for mounting certs from secrets) | `[]` `extraVolumes` | Additional container volumes (eg. for mounting certs from secrets) | `[]`
`extraVolumeMounts` | Additional container volume mounts (eg. for mounting certs from secrets) | `[]` `extraVolumeMounts` | Additional container volume mounts (eg. for mounting certs from secrets) | `[]`
## EMQx-specific ## EMQ X specific settings
The following table lists the configurable [EMQx](https://www.emqx.io/)-specific parameters of the chart and their default values. The following table lists the configurable [EMQ X](https://www.emqx.io/)-specific parameters of the chart and their default values.
Parameter | Description | Default Value Parameter | Description | Default Value
--- | --- | --- --- | --- | ---
`emqxConfig` | Map of [configuration](https://www.emqx.io/docs/en/latest/configuration/configuration.html) items expressed as [environment variables](https://www.emqx.io/docs/en/v4.3/configuration/environment-variable.html) (prefix can be omitted) or using the configuration files [namespaced dotted notation](https://www.emqx.io/docs/en/latest/configuration/configuration.html) | `nil` `emqxConfig` | Map of [configuration](https://www.emqx.io/docs/en/latest/configuration/configuration.html) items expressed as [environment variables](https://www.emqx.io/docs/en/v4.3/configuration/environment-variable.html) (prefix can be omitted) or using the configuration files [namespaced dotted notation](https://www.emqx.io/docs/en/latest/configuration/configuration.html) | `nil`
@ -104,7 +104,7 @@ Parameter | Description | Default Value
# Examples # Examples
This section provides some examples for the configuration of common scenarios. This section provides some examples for the configuration of common scenarios.
## Enable Websockets SSL via [nginx-ingress community controller](https://kubernetes.github.io/ingress-nginx/) ## Enable Websockets SSL via [nginx-ingress community controller](https://kubernetes.github.io/ingress-nginx/)
The following settings describe a working scenario for acessing [EMQx](https://www.emqx.io/) Websockets with SSL termination at the [nginx-ingress community controller](https://kubernetes.github.io/ingress-nginx/). The following settings describe a working scenario for acessing [EMQ X](https://www.emqx.io/) Websockets with SSL termination at the [nginx-ingress community controller](https://kubernetes.github.io/ingress-nginx/).
```yaml ```yaml
ingress: ingress:
wss: wss: