Skip to content

EMQX Operator Overview ​

The EMQX Operator provides native Kubernetes support for deploying and managing EMQX clusters. Its primary goal is to simplify and automate the lifecycle management of EMQX in Kubernetes environments.

EMQX Operator 3.0 requires Kubernetes 1.27 or later. The StatefulSetAutoDeletePVC feature gate is enabled by default in Kubernetes 1.27 and later. If your cluster administrator has disabled it, enable it on the Kubernetes API server and controller manager before using EMQX Operator.

EMQX Operator includes, but is not limited to, the following features:

  • Simplified Deployment: Declare EMQX clusters with EMQX custom resources and deploy them quickly.

    For more details, see the Getting Started guide.

  • Cluster Management: Automate EMQX cluster operations and maintenance, including rolling updates, persistent storage, and synchronization of Kubernetes-managed resources.

    For more details, see the Manage EMQX section.

EMQX and EMQX Operator Compatibility ​

EMQX Operator 3.0.x ​

The EMQX Operator 3.0.x release series is compatible with the following EMQX versions:

  • EMQX 5.9 and 5.10
  • EMQX 6.0 and later

The following API versions are supported:

EMQX Operator 3.0 introduces in-place rolling updates for Core nodes, Deployment-style rollouts for Replicant nodes, and HPA-compatible scaling of Core-Replicant clusters. It does not provide backward compatibility with earlier EMQX CR API versions.

Past Releases ​

EMQX Operator 2.3.x ​

The EMQX Operator 2.3.x release series is fully compatible with the following EMQX versions:

  • EMQX 5.9 and 5.10
  • EMQX 6.0 and later

The following API versions are supported:

EMQX Operator 2.2.x ​

EMQX Operator 2.2.x release series is compatible with the following EMQX versions:

  • EMQX Open Source & Enterprise 5.1.1 – 5.8.x
  • EMQX 5.9 & 5.10 (limited support*)
  • EMQX 6.0 and higher (limited support*)

The following API versions are supported:

  • apps.emqx.io/v2beta1
  • apps.emqx.io/v2alpha1 (deprecated)
  • apps.emqx.io/v1beta4
  • apps.emqx.io/v1beta3 (deprecated)

TIP

* Automatic management of Durable Storage replication is not supported for these versions.