Change EMQX Configurations

Task Target

Change EMQX configuration by bootstrapConfig in EMQX Custom Resource.

Configure EMQX Cluster

The main configuration file of EMQX is /etc/emqx.conf. Starting from version 5.0, EMQX adopts HOCON (opens new window) as the configuration file format.

apps.emqx.io/v2alpha1 EMQX supports configuring EMQX cluster through .spec.bootstrapConfig field. For bootstrapConfig configuration, please refer to the document: bootstrapConfig (opens new window).

TIP

This is only applicable before EMQX is started. If you need to modify the cluster configuration after creating EMQX, please modify it through EMQX Dashboard.

• Save the following content as a YAML file and deploy it with the kubectl apply command

  apiVersion: apps.emqx.io/v2alpha1
  kind: EMQX
  metadata:
     name: emqx
  spec:
     image: emqx:5.0
     imagePullPolicy: IfNotPresent
     bootstrapConfig: |
        listeners.tcp.test {
           bind = "0.0.0.0:1884"
           max_connections = 1024000
        }
     listenersServiceTemplate:
        spec:
           type: LoadBalancer
     dashboardServiceTemplate:
        spec:
           type: LoadBalancer
  

  In the .spec.bootstrapConfig field, we have configured a TCP listener for the EMQX cluster. The name of this listener is: test, and the listening port is: 1884.

• Wait for the EMQX cluster to be ready, you can check the status of EMQX cluster through kubectl get command, please make sure STATUS is Running, this may take some time

  $ kubectl get emqx emqx
  NAME   IMAGE      STATUS    AGE
  emqx   emqx:5.0   Running   10m
  

• Obtain the Dashboard External IP of EMQX cluster and access EMQX console

  EMQX Operator will create two EMQX Service resources, one is emqx-dashboard and the other is emqx-listeners, corresponding to EMQX console and EMQX listening port respectively.

  $ kubectl get svc emqx-dashboard -o json | jq '.status.loadBalancer.ingress[0].ip'
  
  192.168.1.200
  

  Access http://192.168.1.200:18083 through a browser, and use the default username and password admin/public to login EMQX console.

Verify Configuration

• View EMQX cluster listener information

  $ kubectl exec -it emqx-core-0 -c emqx -- emqx_ctl listeners
  

  You can get a print similar to the following, which means that the listener named test configured by us has taken effect.

  tcp:default
     listen_on: 0.0.0.0:1883
     acceptors: 16
     proxy_protocol : false
     running: true
     current_conn: 0
     max_conns : 1024000
  tcp:test
     listen_on: 0.0.0.0:1884
     acceptors: 16
     proxy_protocol : false
     running: true
     current_conn: 0
     max_conns : 1024000