Merge pull request #8616 from mindrunner/helm_ssl_support
feat(helm): add ssl support for helm chart
This commit is contained in:
JianBo He
GitHub
commit
2203852ad9
|
|
@ -1,92 +1,121 @@
|
||||||
# Introduction
|
# Introduction
|
||||||
This chart bootstraps an emqx deployment on a Kubernetes cluster using the Helm package manager.
|
|
||||||
|
This chart bootstraps an emqx deployment on a Kubernetes cluster using the Helm package manager.
|
||||||
|
|
||||||
# Prerequisites
|
# Prerequisites
|
||||||
|
|
||||||
+ Kubernetes 1.6+
|
+ Kubernetes 1.6+
|
||||||
+ Helm
|
+ Helm
|
||||||
|
|
||||||
# Installing the Chart
|
# Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-emqx`:
|
To install the chart with the release name `my-emqx`:
|
||||||
|
|
||||||
+ From github
|
+ From github
|
||||||
```
|
```
|
||||||
$ git clone https://github.com/emqx/emqx.git
|
$ git clone https://github.com/emqx/emqx.git
|
||||||
$ cd emqx/deploy/charts/emqx
|
$ cd emqx/deploy/charts/emqx
|
||||||
$ helm install my-emqx .
|
$ helm install my-emqx .
|
||||||
```
|
```
|
||||||
|
|
||||||
+ From chart repos
|
+ From chart repos
|
||||||
```
|
```
|
||||||
helm repo add emqx https://repos.emqx.io/charts
|
helm repo add emqx https://repos.emqx.io/charts
|
||||||
helm install my-emqx emqx/emqx
|
helm install my-emqx emqx/emqx
|
||||||
```
|
```
|
||||||
> If you want to install an unstable version, you need to add `--devel` when you execute the `helm install` command.
|
> If you want to install an unstable version, you need to add `--devel` when you execute the `helm install` command.
|
||||||
|
|
||||||
# Uninstalling the Chart
|
# Uninstalling the Chart
|
||||||
|
|
||||||
To uninstall/delete the `my-emqx` deployment:
|
To uninstall/delete the `my-emqx` deployment:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ helm del my-emqx
|
$ helm del my-emqx
|
||||||
```
|
```
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
||||||
The following table lists the configurable parameters of the emqx chart and their default values.
|
The following table lists the configurable parameters of the emqx 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 |
|
||||||
| `image.repository` | EMQX Image name |emqx/emqx|
|
| `image.repository` | EMQX Image name | emqx/emqx |
|
||||||
| `image.pullPolicy` | The image pull policy |IfNotPresent|
|
| `image.pullPolicy` | The image pull policy | IfNotPresent |
|
||||||
| `image.pullSecrets ` | The image pull secrets |`[]` (does not add image pull secrets to deployed pods)|
|
| `image.pullSecrets ` | The image pull secrets | `[]` (does not add image pull secrets to deployed pods) |
|
||||||
| `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 |
|
| `recreatePods` | Forces the recreation of pods during upgrades, which can be useful to always apply the most recent configuration. | false |
|
||||||
`podAnnotations ` | Annotations for pod | `{}`
|
| `podAnnotations ` | Annotations for pod | `{}` |
|
||||||
`podManagementPolicy`| To redeploy a chart with existing PVC(s), the value must be set to Parallel to avoid deadlock | `Parallel`
|
| `podManagementPolicy` | To redeploy a chart with existing PVC(s), the value must be set to Parallel to avoid deadlock | `Parallel` |
|
||||||
| `persistence.enabled` | Enable EMQX persistence using PVC |false|
|
| `persistence.enabled` | Enable EMQX persistence using PVC | false |
|
||||||
| `persistence.storageClass` | Storage class of backing PVC |`nil` (uses alpha storage class annotation)|
|
| `persistence.storageClass` | Storage class of backing PVC | `nil` (uses alpha storage class annotation) |
|
||||||
| `persistence.existingClaim` | EMQX data Persistent Volume existing claim name, evaluated as a template |""|
|
| `persistence.existingClaim` | EMQX data Persistent Volume existing claim name, evaluated as a template | "" |
|
||||||
| `persistence.accessMode` | PVC Access Mode for EMQX volume |ReadWriteOnce|
|
| `persistence.accessMode` | PVC Access Mode for EMQX volume | ReadWriteOnce |
|
||||||
| `persistence.size` | PVC Storage Request for EMQX volume |20Mi|
|
| `persistence.size` | PVC Storage Request for EMQX volume | 20Mi |
|
||||||
| `initContainers` | Containers that run before the creation of EMQX containers. They can contain utilities or setup scripts. |`{}`|
|
| `initContainers` | Containers that run before the creation of EMQX containers. They can contain utilities or setup scripts. | `{}` |
|
||||||
| `resources` | CPU/Memory resource requests/limits |{}|
|
| `resources` | CPU/Memory resource requests/limits | {} |
|
||||||
| `nodeSelector` | Node labels for pod assignment |`{}`|
|
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
||||||
| `tolerations` | Toleration labels for pod assignment |`[]`|
|
| `tolerations` | Toleration labels for pod assignment | `[]` |
|
||||||
| `affinity` | Map of node/pod affinities |`{}`|
|
| `affinity` | Map of node/pod affinities | `{}` |
|
||||||
| `service.type` | Kubernetes Service type. |ClusterIP|
|
| `service.type` | Kubernetes Service type. | ClusterIP |
|
||||||
| `service.mqtt` | Port for MQTT. |1883|
|
| `service.mqtt` | Port for MQTT. | 1883 |
|
||||||
| `service.mqttssl` | Port for MQTT(SSL). |8883|
|
| `service.mqttssl` | Port for MQTT(SSL). | 8883 |
|
||||||
| `service.mgmt` | Port for mgmt API. |8081|
|
| `service.mgmt` | Port for mgmt API. | 8081 |
|
||||||
| `service.ws` | Port for WebSocket/HTTP. |8083|
|
| `service.ws` | Port for WebSocket/HTTP. | 8083 |
|
||||||
| `service.wss` | Port for WSS/HTTPS. |8084|
|
| `service.wss` | Port for WSS/HTTPS. | 8084 |
|
||||||
| `service.dashboard` | Port for dashboard. |18083|
|
| `service.dashboard` | Port for dashboard. | 18083 |
|
||||||
| `service.nodePorts.mqtt` | Kubernetes node port for MQTT. |nil|
|
| `service.nodePorts.mqtt` | Kubernetes node port for MQTT. | nil |
|
||||||
| `service.nodePorts.mqttssl` | Kubernetes node port for MQTT(SSL). |nil|
|
| `service.nodePorts.mqttssl` | Kubernetes node port for MQTT(SSL). | nil |
|
||||||
| `service.nodePorts.mgmt` | Kubernetes node port for mgmt API. |nil|
|
| `service.nodePorts.mgmt` | Kubernetes node port for mgmt API. | nil |
|
||||||
| `service.nodePorts.ws` | Kubernetes node port for WebSocket/HTTP. |nil|
|
| `service.nodePorts.ws` | Kubernetes node port for WebSocket/HTTP. | nil |
|
||||||
| `service.nodePorts.wss` | Kubernetes node port for WSS/HTTPS. |nil|
|
| `service.nodePorts.wss` | Kubernetes node port for WSS/HTTPS. | nil |
|
||||||
| `service.nodePorts.dashboard` | Kubernetes node port for dashboard. |nil|
|
| `service.nodePorts.dashboard` | Kubernetes node port for dashboard. | nil |
|
||||||
| `service.loadBalancerIP` | loadBalancerIP for Service | nil |
|
| `service.loadBalancerIP` | loadBalancerIP for Service | nil |
|
||||||
| `service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | [] |
|
| `service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | [] |
|
||||||
| `service.externalIPs` | ExternalIPs for the service | [] |
|
| `service.externalIPs` | ExternalIPs for the service | [] |
|
||||||
| `service.annotations` | Service annotations | {}(evaluated as a template)|
|
| `service.annotations` | Service annotations | {}(evaluated as a template) |
|
||||||
| `ingress.dashboard.enabled` | Enable ingress for EMQX Dashboard | false |
|
| `ingress.dashboard.enabled` | Enable ingress for EMQX Dashboard | false |
|
||||||
| `ingress.dashboard.ingressClassName` | Set the ingress class for EMQX Dashboard | |
|
| `ingress.dashboard.ingressClassName` | Set the ingress class for EMQX Dashboard | |
|
||||||
| `ingress.dashboard.path` | Ingress path for EMQX Dashboard | / |
|
| `ingress.dashboard.path` | Ingress path for EMQX Dashboard | / |
|
||||||
| `ingress.dashboard.pathType` | Ingress pathType for EMQX Dashboard | `ImplementationSpecific`
|
| `ingress.dashboard.pathType` | Ingress pathType for EMQX Dashboard | `ImplementationSpecific` |
|
||||||
| `ingress.dashboard.hosts` | Ingress hosts for EMQX Mgmt API | dashboard.emqx.local |
|
| `ingress.dashboard.hosts` | Ingress hosts for EMQX Mgmt API | dashboard.emqx.local |
|
||||||
| `ingress.dashboard.tls` | Ingress tls for EMQX Mgmt API | [] |
|
| `ingress.dashboard.tls` | Ingress tls for EMQX Mgmt API | [] |
|
||||||
| `ingress.dashboard.annotations` | Ingress annotations for EMQX Mgmt API | {} |
|
| `ingress.dashboard.annotations` | Ingress annotations for EMQX Mgmt API | {} |
|
||||||
| `ingress.mgmt.enabled` | Enable ingress for EMQX Mgmt API | false |
|
| `ingress.mgmt.enabled` | Enable ingress for EMQX Mgmt API | false |
|
||||||
| `ingress.dashboard.ingressClassName` | Set the ingress class for EMQX Mgmt API | |
|
| `ingress.dashboard.ingressClassName` | Set the ingress class for EMQX Mgmt API | |
|
||||||
| `ingress.mgmt.path` | Ingress path for EMQX Mgmt API | / |
|
| `ingress.mgmt.path` | Ingress path for EMQX Mgmt API | / |
|
||||||
| `ingress.mgmt.hosts` | Ingress hosts for EMQX Mgmt API | api.emqx.local |
|
| `ingress.mgmt.hosts` | Ingress hosts for EMQX Mgmt API | api.emqx.local |
|
||||||
| `ingress.mgmt.tls` | Ingress tls for EMQX Mgmt API | [] |
|
| `ingress.mgmt.tls` | Ingress tls for EMQX Mgmt API | [] |
|
||||||
| `ingress.mgmt.annotations` | Ingress annotations for EMQX Mgmt API | {} |
|
| `ingress.mgmt.annotations` | Ingress annotations for EMQX Mgmt API | {} |
|
||||||
| `metrics.enable` | If set to true, [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator) needs to be installed, and emqx_prometheus needs to enable | false |
|
| `metrics.enable` | If set to true, [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator) needs to be installed, and emqx_prometheus needs to enable | false |
|
||||||
| `metrics.type` | Now we only supported "prometheus" | "prometheus" |
|
| `metrics.type` | Now we only supported "prometheus" | "prometheus" |
|
||||||
|
| `ssl.enabled` | Enable SSL support | false |
|
||||||
|
| `ssl.useExisting` | Use existing certificate or let cert-manager generate one | false |
|
||||||
|
| `ssl.existingName` | Name of existing certificate | emqx-tls |
|
||||||
|
| `ssl.dnsnames` | DNS name(s) for certificate to be generated | {} |
|
||||||
|
| `ssl.issuer.name` | Issuer name for certificate generation | letsencrypt-dns |
|
||||||
|
| `ssl.issuer.kind` | Issuer kind for certificate generation | ClusterIssuer |
|
||||||
|
|
||||||
## EMQX specific settings
|
## EMQX specific settings
|
||||||
The following table lists the configurable [EMQX](https://www.emqx.io/)-specific parameters of the chart and their default values.
|
|
||||||
Parameter | Description | Default Value
|
The following table lists the configurable [EMQX](https://www.emqx.io/)-specific parameters of the chart and their
|
||||||
--- | --- | ---
|
default values.
|
||||||
`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`
|
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`
|
||||||
`emqxLicenseSecretName` | Name of the secret that holds the license information | `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/`
|
||||||
|
which needs to explicitly configured by either changing the emqx config file or by passing the following environment variables:
|
||||||
|
|
||||||
|
```
|
||||||
|
EMQX_LISTENERS__SSL__DEFAULT__SSL_OPTIONS__CERTFILE: /tmp/ssl/tls.crt
|
||||||
|
EMQX_LISTENERS__SSL__DEFAULT__SSL_OPTIONS__KEYFILE: /tmp/ssl/tls.key
|
||||||
|
```
|
||||||
|
|
||||||
|
If you chose to use an existing certificate, make sure, you update the filenames accordingly.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -53,6 +53,11 @@ spec:
|
||||||
{{- end }}
|
{{- end }}
|
||||||
spec:
|
spec:
|
||||||
volumes:
|
volumes:
|
||||||
|
{{- if .Values.ssl.enabled }}
|
||||||
|
- name: ssl-cert
|
||||||
|
secret:
|
||||||
|
secretName: {{ include "emqx.fullname" . }}-tls
|
||||||
|
{{- end }}
|
||||||
{{- if not .Values.persistence.enabled }}
|
{{- if not .Values.persistence.enabled }}
|
||||||
- name: emqx-data
|
- name: emqx-data
|
||||||
emptyDir: {}
|
emptyDir: {}
|
||||||
|
|
@ -124,12 +129,17 @@ spec:
|
||||||
volumeMounts:
|
volumeMounts:
|
||||||
- name: emqx-data
|
- name: emqx-data
|
||||||
mountPath: "/opt/emqx/data"
|
mountPath: "/opt/emqx/data"
|
||||||
{{ if .Values.emqxLicenseSecretName }}
|
{{- if .Values.ssl.enabled }}
|
||||||
|
- name: ssl-cert
|
||||||
|
mountPath: /tmp/ssl
|
||||||
|
readOnly: true
|
||||||
|
{{- end}}
|
||||||
|
{{ if .Values.emqxLicenseSecretName }}
|
||||||
- name: emqx-license
|
- name: emqx-license
|
||||||
mountPath: "/opt/emqx/etc/emqx.lic"
|
mountPath: "/opt/emqx/etc/emqx.lic"
|
||||||
subPath: "emqx.lic"
|
subPath: "emqx.lic"
|
||||||
readOnly: true
|
readOnly: true
|
||||||
{{ end }}
|
{{- end }}
|
||||||
readinessProbe:
|
readinessProbe:
|
||||||
httpGet:
|
httpGet:
|
||||||
path: /api/v5/status
|
path: /api/v5/status
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
{{- if and (.Values.ssl.enable) (not .Values.ssl.useExisting) -}}
|
||||||
|
---
|
||||||
|
apiVersion: cert-manager.io/v1
|
||||||
|
kind: Certificate
|
||||||
|
metadata:
|
||||||
|
name: {{ include "emqx.fullname" . }}-tls
|
||||||
|
spec:
|
||||||
|
secretName: {{ include "emqx.fullname" . }}-tls
|
||||||
|
issuerRef:
|
||||||
|
name: {{ default "letsencrypt-staging" .Values.ssl.issuer.name }}
|
||||||
|
kind: {{ default "ClusterIssuer" .Values.ssl.issuer.kind }}
|
||||||
|
dnsNames:
|
||||||
|
{{- range .Values.ssl.dnsnames }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end -}}
|
||||||
|
|
@ -203,3 +203,12 @@ containerSecurityContext:
|
||||||
metrics:
|
metrics:
|
||||||
enabled: false
|
enabled: false
|
||||||
type: prometheus
|
type: prometheus
|
||||||
|
|
||||||
|
ssl:
|
||||||
|
enabled: false
|
||||||
|
useExisting: false
|
||||||
|
existingName: emqx-tls
|
||||||
|
dnsnames: {}
|
||||||
|
issuer:
|
||||||
|
name: letsencrypt-dns
|
||||||
|
kind: ClusterIssuer
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue