docs: enhance markdown indent and fix typos
This commit is contained in:
JimMoen
parent
572f465346
commit
a35ed4dacb
|
|
@ -11,14 +11,14 @@ This chart bootstraps an emqx deployment on a Kubernetes cluster using the Helm
|
|||
|
||||
To install the chart with the release name `my-emqx`:
|
||||
|
||||
+ From github
|
||||
+ From Github
|
||||
```
|
||||
$ git clone https://github.com/emqx/emqx.git
|
||||
$ cd emqx/deploy/charts/emqx-enterprise
|
||||
$ helm install my-emqx .
|
||||
```
|
||||
|
||||
+ From chart repos
|
||||
+ From chart Repos
|
||||
```
|
||||
helm repo add emqx https://repos.emqx.io/charts
|
||||
helm install my-emqx emqx/emqx-enterprise
|
||||
|
|
@ -44,9 +44,9 @@ The following table lists the configurable parameters of the emqx chart and thei
|
|||
| `image.pullPolicy` | The image pull policy | IfNotPresent |
|
||||
| `image.pullSecrets ` | The image pull secrets | `[]` (does not add image pull secrets to deployed pods) |
|
||||
| `serviceAccount.create` | If `true`, create a new service account | `true` |
|
||||
| `serviceAccount.name` | Service account to be used. If not set and `serviceAccount.create` is `true`, a name is generated using the fullname template | |
|
||||
| `serviceAccount.name` | Service account to be used. If not set and `serviceAccount.create` is `true`, a name is generated using the full-name template | |
|
||||
| `serviceAccount.annotations` | Annotations to add to the service account | |
|
||||
| `envFromSecret` | The name pull a secret in the same kubernetes namespace which contains values that will be added to the environment | nil |
|
||||
| `envFromSecret` | The name pull a secret in the same Kubernetes namespace which contains values that will be added to the environment | nil |
|
||||
| `recreatePods` | Forces the recreation of pods during upgrades, which can be useful to always apply the most recent configuration. | false |
|
||||
| `podAnnotations ` | Annotations for pod | `{}` |
|
||||
| `podManagementPolicy` | To redeploy a chart with existing PVC(s), the value must be set to Parallel to avoid deadlock | `Parallel` |
|
||||
|
|
@ -58,7 +58,7 @@ The following table lists the configurable parameters of the emqx chart and thei
|
|||
| `initContainers` | Containers that run before the creation of EMQX containers. They can contain utilities or setup scripts. | `{}` |
|
||||
| `resources` | CPU/Memory resource requests/limits | {} |
|
||||
| `extraVolumeMounts` | Additional volumeMounts to the default backend container. | [] |
|
||||
| `extraVolumes` | Additional volumes to the default backend pod.| [] |
|
||||
| `extraVolumes` | Additional volumes to the default backend pod. | [] |
|
||||
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
||||
| `tolerations` | Toleration labels for pod assignment | `[]` |
|
||||
| `affinity` | Map of node/pod affinities | `{}` |
|
||||
|
|
@ -77,9 +77,9 @@ The following table lists the configurable parameters of the emqx chart and thei
|
|||
| `service.loadBalancerIP` | loadBalancerIP for Service | nil |
|
||||
| `service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | [] |
|
||||
| `service.externalIPs` | ExternalIPs for the service | [] |
|
||||
| `service.externalTrafficPolicy` | External Traffic Policy for the service | `Cluster`
|
||||
| `service.externalTrafficPolicy` | External Traffic Policy for the service | `Cluster` |
|
||||
| `service.annotations` | Service/ServiceMonitor annotations | {}(evaluated as a template) |
|
||||
| `service.labels` | Service/ServiceMontior labels | {}(evaluated as a template) |
|
||||
| `service.labels` | Service/ServiceMonitor labels | {}(evaluated as a template) |
|
||||
| `ingress.dashboard.enabled` | Enable ingress for EMQX Dashboard | false |
|
||||
| `ingress.dashboard.ingressClassName` | Set the ingress class for EMQX Dashboard | |
|
||||
| `ingress.dashboard.path` | Ingress path for EMQX Dashboard | / |
|
||||
|
|
@ -110,12 +110,12 @@ The following table lists the configurable parameters of the emqx chart and thei
|
|||
|
||||
The following table lists the configurable [EMQX](https://www.emqx.io/)-specific parameters of the chart and their
|
||||
default values.
|
||||
Parameter | Description | Default Value
|
||||
--- | --- | ---
|
||||
`emqxConfig` | Map of [configuration](https://www.emqx.io/docs/en/v5.0/admin/cfg.html) items
|
||||
expressed as [environment variables](https://www.emqx.io/docs/en/v5.0/admin/cfg.html#environment-variables) (prefix `EMQX_` can be omitted) or using the configuration
|
||||
files [namespaced dotted notation](https://www.emqx.io/docs/en/v5.0/admin/cfg.html#syntax) | `nil`
|
||||
`emqxLicenseSecretName` | Name of the secret that holds the license information | `nil`
|
||||
| Parameter | Description | Default Value |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|---------------|
|
||||
| `emqxConfig` | Map of [configuration](https://www.emqx.io/docs/en/v5.0/admin/cfg.html) items | |
|
||||
| expressed as [environment variables](https://www.emqx.io/docs/en/v5.0/admin/cfg.html#environment-variables) (prefix `EMQX_` can be omitted) or using the configuration | | |
|
||||
| files [namespaced dotted notation](https://www.emqx.io/docs/en/v5.0/admin/cfg.html#syntax) | `nil` | |
|
||||
| `emqxLicenseSecretName` | Name of the secret that holds the license information | `nil` |
|
||||
|
||||
## SSL settings
|
||||
`cert-manager` generates secrets with certificate data using the keys `tls.crt` and `tls.key`. The helm chart always mounts those keys as files to `/tmp/ssl/`
|
||||
|
|
@ -136,9 +136,8 @@ In order to preserve the original client's IP address, you could change the emqx
|
|||
EMQX_LISTENERS__TCP__DEFAULT__PROXY_PROTOCOL: "true"
|
||||
```
|
||||
|
||||
With haproxy you'd also need the following ingress annotation:
|
||||
With HAProxy you'd also need the following ingress annotation:
|
||||
|
||||
```
|
||||
haproxy-ingress.github.io/proxy-protocol: "v2"
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -11,14 +11,14 @@ This chart bootstraps an emqx deployment on a Kubernetes cluster using the Helm
|
|||
|
||||
To install the chart with the release name `my-emqx`:
|
||||
|
||||
+ From github
|
||||
+ From Github
|
||||
```
|
||||
$ git clone https://github.com/emqx/emqx.git
|
||||
$ cd emqx/deploy/charts/emqx
|
||||
$ helm install my-emqx .
|
||||
```
|
||||
|
||||
+ From chart repos
|
||||
+ From chart Repos
|
||||
```
|
||||
helm repo add emqx https://repos.emqx.io/charts
|
||||
helm install my-emqx emqx/emqx
|
||||
|
|
@ -44,9 +44,9 @@ The following table lists the configurable parameters of the emqx chart and thei
|
|||
| `image.pullPolicy` | The image pull policy | IfNotPresent |
|
||||
| `image.pullSecrets ` | The image pull secrets | `[]` (does not add image pull secrets to deployed pods) |
|
||||
| `serviceAccount.create` | If `true`, create a new service account | `true` |
|
||||
| `serviceAccount.name` | Service account to be used. If not set and `serviceAccount.create` is `true`, a name is generated using the fullname template | |
|
||||
| `serviceAccount.name` | Service account to be used. If not set and `serviceAccount.create` is `true`, a name is generated using the full-name template | |
|
||||
| `serviceAccount.annotations` | Annotations to add to the service account | |
|
||||
| `envFromSecret` | The name pull a secret in the same kubernetes namespace which contains values that will be added to the environment | nil |
|
||||
| `envFromSecret` | The name pull a secret in the same Kubernetes namespace which contains values that will be added to the environment | nil |
|
||||
| `recreatePods` | Forces the recreation of pods during upgrades, which can be useful to always apply the most recent configuration. | false |
|
||||
| `podAnnotations ` | Annotations for pod | `{}` |
|
||||
| `podManagementPolicy` | To redeploy a chart with existing PVC(s), the value must be set to Parallel to avoid deadlock | `Parallel` |
|
||||
|
|
@ -58,7 +58,7 @@ The following table lists the configurable parameters of the emqx chart and thei
|
|||
| `initContainers` | Containers that run before the creation of EMQX containers. They can contain utilities or setup scripts. | `{}` |
|
||||
| `resources` | CPU/Memory resource requests/limits | {} |
|
||||
| `extraVolumeMounts` | Additional volumeMounts to the default backend container. | [] |
|
||||
| `extraVolumes` | Additional volumes to the default backend pod.| [] |
|
||||
| `extraVolumes` | Additional volumes to the default backend pod. | [] |
|
||||
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
||||
| `tolerations` | Toleration labels for pod assignment | `[]` |
|
||||
| `affinity` | Map of node/pod affinities | `{}` |
|
||||
|
|
@ -78,9 +78,9 @@ The following table lists the configurable parameters of the emqx chart and thei
|
|||
| `service.loadBalancerIP` | loadBalancerIP for Service | nil |
|
||||
| `service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | [] |
|
||||
| `service.externalIPs` | ExternalIPs for the service | [] |
|
||||
| `service.externalTrafficPolicy` | External Traffic Policy for the service | `Cluster`
|
||||
| `service.externalTrafficPolicy` | External Traffic Policy for the service | `Cluster` |
|
||||
| `service.annotations` | Service/ServiceMonitor annotations | {}(evaluated as a template) |
|
||||
| `service.labels` | Service/ServiceMontior labels | {}(evaluated as a template) |
|
||||
| `service.labels` | Service/ServiceMonitor labels | {}(evaluated as a template) |
|
||||
| `ingress.dashboard.enabled` | Enable ingress for EMQX Dashboard | false |
|
||||
| `ingress.dashboard.ingressClassName` | Set the ingress class for EMQX Dashboard | |
|
||||
| `ingress.dashboard.path` | Ingress path for EMQX Dashboard | / |
|
||||
|
|
@ -111,12 +111,12 @@ The following table lists the configurable parameters of the emqx chart and thei
|
|||
|
||||
The following table lists the configurable [EMQX](https://www.emqx.io/)-specific parameters of the chart and their
|
||||
default values.
|
||||
Parameter | Description | Default Value
|
||||
--- | --- | ---
|
||||
`emqxConfig` | Map of [configuration](https://www.emqx.io/docs/en/v5.0/admin/cfg.html) items
|
||||
expressed as [environment variables](https://www.emqx.io/docs/en/v5.0/admin/cfg.html#environment-variables) (prefix `EMQX_` can be omitted) or using the configuration
|
||||
files [namespaced dotted notation](https://www.emqx.io/docs/en/v5.0/admin/cfg.html#syntax) | `nil`
|
||||
`emqxLicenseSecretName` | Name of the secret that holds the license information | `nil`
|
||||
| Parameter | Description | Default Value |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|---------------|
|
||||
| `emqxConfig` | Map of [configuration](https://www.emqx.io/docs/en/v5.0/admin/cfg.html) items | |
|
||||
| expressed as [environment variables](https://www.emqx.io/docs/en/v5.0/admin/cfg.html#environment-variables) (prefix `EMQX_` can be omitted) or using the configuration | | |
|
||||
| files [namespaced dotted notation](https://www.emqx.io/docs/en/v5.0/admin/cfg.html#syntax) | `nil` | |
|
||||
| `emqxLicenseSecretName` | Name of the secret that holds the license information | `nil` |
|
||||
|
||||
## SSL settings
|
||||
`cert-manager` generates secrets with certificate data using the keys `tls.crt` and `tls.key`. The helm chart always mounts those keys as files to `/tmp/ssl/`
|
||||
|
|
@ -137,9 +137,8 @@ In order to preserve the original client's IP address, you could change the emqx
|
|||
EMQX_LISTENERS__TCP__DEFAULT__PROXY_PROTOCOL: "true"
|
||||
```
|
||||
|
||||
With haproxy you'd also need the following ingress annotation:
|
||||
With HAProxy you'd also need the following ingress annotation:
|
||||
|
||||
```
|
||||
haproxy-ingress.github.io/proxy-protocol: "v2"
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue