Release Note 🍻

EMQX Operator 2.1.1 is released.

Supported version

• apps.emqx.io/v2alpha1

  • EMQX at 5.0.14 and later
  • EMQX Enterprise at 5.0.0 and later

• apps.emqx.io/v1beta4

  • EMQX at 4.4.14 and later
  • EMQX Enterprise at 4.4.14 and later

Features 🌈

• Support EMQX Enterprise 5.0

  Users can deploy EMQX Enterprise 5.0 by creating an EMQX custom resource with the spec.image field set to emqx/emqx-enterprise:5.0.0.

  And users can update to EMQX Enterprise 5.0 from EMQX 5.0, by just changing the spec.image field to emqx/emqx-enterprise:5.0.0 in the EMQX custom resource when the EMQX cluster is running.

  Note: Just can updating to EMQX Enterprise 5.0 from EMQX 5.0, not support updating EMQX Enterprise 5.0 from EMQX 5.0.

• Add new field bootstrap API keys in apps.emqx.io/v1beta4 and apps.emqx.io/v2alpha1

  Users can customize the keys and secrets required to request EMQX's API before EMQX is started, which helps with some of the operations tasks, until then, users must wait for EMQX to be ready and add them manually via the EMQX Dashboard.

Fixes 🛠

• apps.emqx.io/v2alpha1

  • Fix an issue with EMQX pods not inheriting EMQX Custom Resource annotations

• apps.emqx.io/v1beta4

  • Fixed an issue where EMQX blue-green updating would not start in some cases
  • Fixed an issue where .spec.persistence did not work in some cases

How to install/upgrade EMQX Operator 2.1.1 💡

Need make sure the cert-manager is ready

helm repo add emqx https://repos.emqx.io/charts
helm repo update
helm upgrade --install emqx-operator emqx/emqx-operator \
  --namespace emqx-operator-system \
  --create-namespace

If you have deployed apps.emqx.io/v1beta3 resources, EMQX Operator will automatically convert them to apps.emqx.io/v1beta4 resources, all without any manual intervention.

The resources of apps.emqx.io/v2alpha1 will not receive any impact.

Warning 🚨

apps.emqx.io/v1beta3 will be dropped soon

What's Changed

• chore: add path fix for codecov by @Rory-Z in #588
• chore: fix some error for test case by @Rory-Z in #589
• chore: optimize some add_emqx_statefulset functions by @elpsyr in #592
• docs: update log collection by @jacky-xbb in #591
• docs: add prometheus doc by @Gala-R in #590
• fix: fix update emqxConfig field causes blueGreenUpdate exception by @Gala-R in #595
• docs: update nlb config of aws eks by @logo306142054 in #594
• fix: merge sts annotation to pod spec by @logo306142054 in #596
• debug: support to debug webhook at local env by @logo306142054 in #598
• feat: add imagepullsecret to service account. by @JBrejnholt in #599
• fix: spelling of storageclass by @Jaxwood in #600
• chore: add code owner file by @Rory-Z in #604
• chore(CI): check line-break at EOF by @Rory-Z in #605
• chore: fix wrong field name in example yaml by @Rory-Z in #606
• chore: fix wrong field name in example yaml by @Rory-Z in #607
• chore: change 1.19.3 to 1.19 in github workflows by @Rory-Z in #608
• docs: add some notes in getting-started by @Gala-R in #602
• feature: add user-defined apikey by @logo306142054 in #603
• feat: add user-defined apikey for v1beta4 by @logo306142054 in #611
• feat: forbid to update bootstrap api key by @logo306142054 in #615
• docs: update docs by @jacky-xbb in #618
• docs: add release note for 2.1.1 by @Rory-Z in #610
• docs: add GKE info by @josex2r in #620
• docs: update RELEASE.md by @Rory-Z in #619
• docs: change request kubernetes version by @Rory-Z in #621
• chore(helm): don't check kubeversion by @Rory-Z in #622

New Contributors

• @elpsyr made their first contribution in #592
• @JBrejnholt made their first contribution in #599
• @Jaxwood made their first contribution in #600
• @josex2r made their first contribution in #620

Full Changelog: 2.1.0...2.1.1