From b91dc1c13d448b3ca465da5cbeafa2a36bb58642 Mon Sep 17 00:00:00 2001 From: Fernando Almeida Date: Wed, 26 Jan 2022 09:01:25 +0000 Subject: [PATCH] fix(helm-chart): revised software name to match conventioned name fix(helm-chart): added missing new-line from resource templates --- deploy/charts/emqx/README.md | 56 +++++++++---------- .../charts/emqx/templates/configmap.acl.yaml | 2 +- .../charts/emqx/templates/configmap.env.yaml | 2 +- .../templates/configmap.loadedModules.yaml | 2 +- .../templates/configmap.loadedPlugins.yaml | 2 +- deploy/charts/emqx/templates/rbac.yaml | 2 +- deploy/charts/emqx/values.yaml | 12 ++-- 7 files changed, 39 insertions(+), 39 deletions(-) diff --git a/deploy/charts/emqx/README.md b/deploy/charts/emqx/README.md index 7a4358be6..4837ffced 100644 --- a/deploy/charts/emqx/README.md +++ b/deploy/charts/emqx/README.md @@ -1,5 +1,5 @@ # 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 + [Kubernetes](https://kubernetes.io/) 1.6+ @@ -30,8 +30,8 @@ $ helm del my-emqx # Configuration The following sections describe the configurable parameters of the chart and their default values. -## K8s-specific -The following table lists the configurable K8s parameters of the [EMQx](https://www.emqx.io/) chart and their default values. +## [K8s]((https://kubernetes.io/)) specific settings +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 --- | --- | --- `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` @@ -40,12 +40,12 @@ Parameter | Description | Default Value `image.pullPolicy` | The image pull policy | `IfNotPresent` `image.pullSecrets ` | The image pull secrets (does not add image pull secrets to deployed pods) |``[]`` `recreatePods` | Forces the recreation of pods during upgrades, which can be useful to always apply the most recent configuration. | `false` -`persistence.enabled` | Enable EMQX persistence using PVC | `false` +`persistence.enabled` | Enable EMQ X persistence using PVC | `false` `persistence.storageClass` | Storage class of backing PVC (uses alpha storage class annotation) | `nil` `persistence.existingClaim` | EMQ X data Persistent Volume existing claim name, evaluated as a template | `""` -`persistence.accessMode` | PVC Access Mode for EMQX volume | `ReadWriteOnce` -`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. |`{}` +`persistence.accessMode` | PVC Access Mode for EMQ X volume | `ReadWriteOnce` +`persistence.size` | PVC Storage Request for EMQ X volume | `20Mi` +`initContainers` | Containers that run before the creation of EMQ X containers. They can contain utilities or setup scripts. |`{}` `resources` | CPU/Memory resource requests/limits |`{}` `nodeSelector` | Node labels for pod assignment |`{}` `tolerations` | Toleration labels for pod assignment |``[]`` @@ -67,32 +67,32 @@ Parameter | Description | Default Value `service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | `[]` `service.externalIPs` | ExternalIPs for the service | `[]` `service.annotations` | Service annotations (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 | `/` -`ingress.dashboard.hosts` | Ingress hosts for EMQX Mgmt API | dashboard.emqx.local -`ingress.dashboard.tls` | Ingress tls for EMQX Mgmt API | `[]` -`ingress.dashboard.annotations` | Ingress annotations for EMQX Mgmt API | `{}` -`ingress.mgmt.enabled` | Enable ingress for EMQX Mgmt API | `false` -`ingress.mqtt.ingressClassName` | Set the ingress class for EMQX Mgmt API | `nil` -`ingress.mgmt.path` | Ingress path for EMQX Mgmt API | `/` -`ingress.mgmt.hosts` | Ingress hosts for EMQX Mgmt API | `api.emqx.local` -`ingress.mgmt.tls` | Ingress tls for EMQX Mgmt API | `[]` -`ingress.mgmt.annotations` | Ingress annotations for EMQX Mgmt API | `{}` -`ingress.wss.enabled` | Enable ingress for EMQX Mgmt API | `false` -`ingress.wss.ingressClassName` | Set the ingress class for EMQX Mgmt API | `nil` -`ingress.wss.path` | Ingress path for EMQX WSS | `/` -`ingress.wss.hosts` | Ingress hosts for EMQX WSS | `wss.emqx.local` -`ingress.wss.tls` | Ingress tls for EMQX WSS | `[]` -`ingress.wss.annotations` | Ingress annotations for EMQX WSS | `{}` +`ingress.dashboard.enabled` | Enable ingress for EMQ X Dashboard | false +`ingress.dashboard.ingressClassName` | Set the ingress class for EMQ X Dashboard +`ingress.dashboard.path` | Ingress path for EMQ X Dashboard | `/` +`ingress.dashboard.hosts` | Ingress hosts for EMQ X Mgmt API | dashboard.emqx.local +`ingress.dashboard.tls` | Ingress tls for EMQ X Mgmt API | `[]` +`ingress.dashboard.annotations` | Ingress annotations for EMQ X Mgmt API | `{}` +`ingress.mgmt.enabled` | Enable ingress for EMQ X Mgmt API | `false` +`ingress.mqtt.ingressClassName` | Set the ingress class for EMQ X Mgmt API | `nil` +`ingress.mgmt.path` | Ingress path for EMQ X Mgmt API | `/` +`ingress.mgmt.hosts` | Ingress hosts for EMQ X Mgmt API | `api.emqx.local` +`ingress.mgmt.tls` | Ingress tls for EMQ X Mgmt API | `[]` +`ingress.mgmt.annotations` | Ingress annotations for EMQ X Mgmt API | `{}` +`ingress.wss.enabled` | Enable ingress for EMQ X Mgmt API | `false` +`ingress.wss.ingressClassName` | Set the ingress class for EMQ X Mgmt API | `nil` +`ingress.wss.path` | Ingress path for EMQ X WSS | `/` +`ingress.wss.hosts` | Ingress hosts for EMQ X WSS | `wss.emqx.local` +`ingress.wss.tls` | Ingress tls for EMQ X WSS | `[]` +`ingress.wss.annotations` | Ingress annotations for EMQ X WSS | `{}` `extraEnv` | Aditional container env vars | `[]` `extraEnvFrom` | Aditional container env from vars (eg. [config map](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/), [secrets](https://kubernetes.io/docs/concepts/configuration/secret/) | `[]` `extraArgs` | Additional container executable arguments | `[]` `extraVolumes` | Additional container volumes (eg. for mounting certs from secrets) | `[]` `extraVolumeMounts` | Additional container volume mounts (eg. for mounting certs from secrets) | `[]` -## EMQx-specific -The following table lists the configurable [EMQx](https://www.emqx.io/)-specific parameters of the chart and their default values. +## EMQ X specific settings +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 --- | --- | --- `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 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/) -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 ingress: wss: diff --git a/deploy/charts/emqx/templates/configmap.acl.yaml b/deploy/charts/emqx/templates/configmap.acl.yaml index 897ea0f48..25f67b42b 100644 --- a/deploy/charts/emqx/templates/configmap.acl.yaml +++ b/deploy/charts/emqx/templates/configmap.acl.yaml @@ -12,4 +12,4 @@ metadata: data: "acl.conf": | {{ .Values.emqxAclConfig }} -{{ end }} \ No newline at end of file +{{ end }} diff --git a/deploy/charts/emqx/templates/configmap.env.yaml b/deploy/charts/emqx/templates/configmap.env.yaml index c27b65343..851a7496b 100644 --- a/deploy/charts/emqx/templates/configmap.env.yaml +++ b/deploy/charts/emqx/templates/configmap.env.yaml @@ -17,4 +17,4 @@ data: {{- end }} {{- end}} -{{- end }} \ No newline at end of file +{{- end }} diff --git a/deploy/charts/emqx/templates/configmap.loadedModules.yaml b/deploy/charts/emqx/templates/configmap.loadedModules.yaml index 099db396a..45c97d4d0 100644 --- a/deploy/charts/emqx/templates/configmap.loadedModules.yaml +++ b/deploy/charts/emqx/templates/configmap.loadedModules.yaml @@ -12,4 +12,4 @@ metadata: data: "loaded_modules": | {{ .Values.emqxLoadedModules }} -{{ end }} \ No newline at end of file +{{ end }} diff --git a/deploy/charts/emqx/templates/configmap.loadedPlugins.yaml b/deploy/charts/emqx/templates/configmap.loadedPlugins.yaml index df77368f9..242c1ab01 100644 --- a/deploy/charts/emqx/templates/configmap.loadedPlugins.yaml +++ b/deploy/charts/emqx/templates/configmap.loadedPlugins.yaml @@ -12,4 +12,4 @@ metadata: data: "loaded_plugins": | {{ .Values.emqxLoadedPlugins }} -{{ end }} \ No newline at end of file +{{ end }} diff --git a/deploy/charts/emqx/templates/rbac.yaml b/deploy/charts/emqx/templates/rbac.yaml index 87cd18178..45806d698 100644 --- a/deploy/charts/emqx/templates/rbac.yaml +++ b/deploy/charts/emqx/templates/rbac.yaml @@ -39,4 +39,4 @@ subjects: roleRef: kind: Role name: {{ include "emqx.fullname" . }} - apiGroup: rbac.authorization.k8s.io \ No newline at end of file + apiGroup: rbac.authorization.k8s.io diff --git a/deploy/charts/emqx/values.yaml b/deploy/charts/emqx/values.yaml index d78f19a8e..f630f3d25 100644 --- a/deploy/charts/emqx/values.yaml +++ b/deploy/charts/emqx/values.yaml @@ -62,13 +62,13 @@ resources: {} # cpu: 500m # memory: 512Mi -# Containers that run before the creation of EMQX containers. They can contain utilities or setup scripts. +# Containers that run before the creation of EMQ X containers. They can contain utilities or setup scripts. initContainers: {} # - name: mysql-probe # image: alpine # command: ["sh", "-c", "for i in $(seq 1 300); do nc -zvw1 mysql 3306 && exit 0 || sleep 3; done; exit 1"] -## EMQX configuration item, see the documentation (https://hub.docker.com/r/emqx/emqx) +## EMQ X configuration item, see the documentation (https://hub.docker.com/r/emqx/emqx) emqxConfig: EMQX_CLUSTER__K8S__APISERVER: "https://kubernetes.default.svc:443" ## The address type is used to extract host from k8s service. @@ -119,7 +119,7 @@ emqxLoadedModules: > {emqx_mod_subscription, false}. {emqx_mod_topic_metrics, false}. -## EMQX Enterprise Edition requires manual creation of a Secret containing the licensed content. Write the name of Secret to the value of "emqxLicenseSecretName" +## EMQ X Enterprise Edition requires manual creation of a Secret containing the licensed content. Write the name of Secret to the value of "emqxLicenseSecretName" ## Example: ## kubectl create secret generic emqx-license-secret-name --from-file=/path/to/emqx.lic emqxLicenseSecretName: @@ -188,7 +188,7 @@ ingress: ## Ingress shared annotations annotations: {} - ## ingress for EMQX Dashboard + ## ingress for EMQ X Dashboard dashboard: enabled: false annotations: {} @@ -199,7 +199,7 @@ ingress: - dashboard.emqx.local tls: [] - ## ingress for EMQX Mgmt API + ## ingress for EMQ X Mgmt API mgmt: enabled: false annotations: {} @@ -210,7 +210,7 @@ ingress: - api.emqx.local tls: [] - ## ingress for EMQX Mgmt API + ## ingress for EMQ X Mgmt API wss: enabled: false # ingressClassName: nginx