# EMQX
Sample
apiVersion: apps.emqx.io/v1beta2
kind: EmqxBroker
metadata:
name: emqx
spec:
serviceAccountName: "emqx"
image: emqx/emqx:4.3.11
replicas: 3
labels:
cluster: emqx
storage:
storageClassName: standard
resources:
requests:
storage: 20Mi
accessModes:
- ReadWriteOnce
emqxTemplate:
listener:
type: ClusterIP
ports:
mqtt: 1883
mqtts: 8883
ws: 8083
wss: 8084
dashboard: 18083
api: 8081
acl:
- permission: allow
username: "dashboard"
action: subscribe
topics:
filter:
- "$SYS/#"
- "#"
- permission: allow
ipaddress: "127.0.0.1"
topics:
filter:
- "$SYS/#"
equal:
- "#"
- permission: deny
action: subscribe
topics:
filter:
- "$SYS/#"
equal:
- "#"
- permission: allow
plugins:
- name: emqx_management
enable: true
- name: emqx_recon
enable: true
- name: emqx_retainer
enable: true
- name: emqx_dashboard
enable: true
- name: emqx_telemetry
enable: true
- name: emqx_rule_engine
enable: true
- name: emqx_bridge_mqtt
enable: false
modules:
- name: emqx_mod_acl_internal
enable: true
- name: emqx_mod_presence
enable: true
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
- Config image
image: my-repo/emqx:4.3.10
1
- Config storage
storage:
volumeClaimTemplate:
spec:
storageClassName: standard
resources:
requests:
storage: 20Mi
accessModes:
- ReadWriteOnce
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Field | Default | Description |
---|---|---|
storageClassName | standard | the name of storage class |
storage | 20Mi | storage size |
accessModes | ReadWriteOnce | access mode,include ReadWriteOnce,ReadOnlyMany or ReadWriteMany |
- Config Load Balancer
listener:
type: ClusterIP
ports:
mqtt: 1883
mqtts: 8883
ws: 8083
wss: 8084
dashboard: 18083
api: 8081
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Field | Default | Description |
---|---|---|
type | ClusterIP | listener type,include ClusterIP or LoadBalancer |
ports | mqtt: 1883 mqtts: 8883 ws: 8083 wss: 8084 dashboard: 18083 api: 8081 | ports of EMQX, please EMQX docs (opens new window) |
There are different annotations depend on cloud platform. For example,
service.beta.kubernetes.io/aws-load-balancer-type: nlb
need to be set on AWS.
- Config ACL
acl:
- permission: allow
username: "dashboard"
action: subscribe
topics:
filter:
- "$SYS/#"
- "#"
- permission: allow
ipaddress: "127.0.0.1"
topics:
filter:
- "$SYS/#"
equal:
- "#"
- permission: deny
action: subscribe
topics:
filter:
- "$SYS/#"
equal:
- "#"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Field | Description |
---|---|
permission | the permission control operation is performed. The possible values are: allow or deny |
username | the rule only takes effect for users whose Username is dashboard |
action | the operation controlled by the rule with the possible value: publish,subscribe,pubsub |
topics.filter | which means that the rule is applied to topics |
- config plugins
plugins:
- name: emqx_management
enable: true
- name: emqx_recon
enable: true
- name: emqx_retainer
enable: true
- name: emqx_dashboard
enable: true
- name: emqx_telemetry
enable: true
- name: emqx_rule_engine
enable: true
- name: emqx_bridge_mqtt
enable: false
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Field | Description |
---|---|
name | the name of plugins |
enable | enable or disable plugins with possible values: true or false |
Refer to EMQX docs (opens new window)
- config modules
modules:
- name: emqx_mod_acl_internal
enable: true
- name: emqx_mod_presence
enable: true
1
2
3
4
5
2
3
4
5
Field | Description |
---|---|
name | the name of module |
enable | enable or disable modules with possible values: true or false |
Refer to EMQX docs (opens new window)
- config license(only for EMQX Enterprise)
Field | Default | Description |
---|---|---|
license | n/a | license context |
- config prometheus monitoring
plugins:
- name: emqx_prometheus
enable: true
env:
- name: EMQX_PROMETHEUS__PUSH__GATEWAY__SERVER
value: ${push_gateway_url}:9091
1
2
3
4
5
6
2
3
4
5
6
Field | Description |
---|---|
env.name | the name of env |
env.value | the value of env |
What’s on this page