Skip to content

Getting Started

In this section, we will walk you through the steps required to efficiently set up the environment for the EMQX Operator, install the Operator, and then use it to deploy EMQX. By following the guidelines outlined in this section, you will be able to effectively install and manage EMQX using the EMQX Operator.

Prepare the Environment

Before deploying EMQX Operator, please confirm that the following components have been ready:

Install EMQX Operator

  1. Install and start cert-manager.


    cert-manager version 1.1.6 or higher is required. Skip this step if the cert-manager is already installed and started.

    You can use Helm to install cert-manager.

    $ helm repo add jetstack
    $ helm repo update
    $ helm upgrade --install cert-manager jetstack/cert-manager \
      --namespace cert-manager \
      --create-namespace \
      --set installCRDs=true

    Or you can follow the cert-manager installation guide to install it.


    If you install cert-manager on Google Kubernetes Engine (GKE) with default configuration may cause bootstrapping issues. Therefore, by adding the configuration of --set global.leaderElection.namespace=cert-manager, configure to use a different namespace in leader election. Please check cert-manager compatibility

  2. Install the EMQX Operator with the command below:

    $ helm repo add emqx
    $ helm repo update
    $ helm upgrade --install emqx-operator emqx/emqx-operator \
      --namespace emqx-operator-system \
  3. Wait till EMQX Operator is ready:

    $ kubectl wait --for=condition=Ready pods -l "control-plane=controller-manager" -n emqx-operator-system
    pod/emqx-operator-controller-manager-57bd7b8bd4-h2mcr condition met

Now that you have successfully installed the operator, you are ready to proceed to the next step. In the Deploy EMQX section, you will learn how to use the EMQX Operator to deploy EMQX.

Alternatively, if you are interested in learning how to upgrade or uninstall EMQX using the operator, you can continue reading this section.

Deploy EMQX