EMQX Operator 2.1.3 Released

Release Note 🍻

EMQX Operator 2.1.3 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 🌈

• Add new CRD apps.emqx.io/v1beta4 rebalance to support the cluster load rebalancing, for more details, please refer to Cluster Load Rebalancing.

Fixes 🛠

• apps.emqx.io/v2alpha1

  • Fixed an issue of the extra containers not working.

How to install/upgrade EMQX Operator 2.1.3 💡

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

EMQX Operator 2.1.3-rc.1 Released

Release Note 🍻

EMQX Operator 2.1.3 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 🌈

• Add new CRD apps.emqx.io/v1beta4 rebalance to support the cluster load rebalancing, for more details, please refer to Cluster Load Rebalancing.

Fixes 🛠

• apps.emqx.io/v2alpha1

  • Fixed an issue of the extra containers not working.

How to install/upgrade EMQX Operator 2.1.3 💡

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

• ci: remove pre-releases from the document version list by @Swilder-M in #767
• docs: update monitor task by @logo306142054 in #774
• fix: fix extra container not work by @Rory-Z in #778
• feat(main2-1): support rebalance for v1teta4 by @Gala-R in #775
• docs(main-2.1): add rebalance doc by @Gala-R in #781

Full Changelog: 2.1.2...2.1.3-rc.1

EMQX Operator 1.2.7-ecp.1 Released

Release Note 🍻

EMQX Operator 1.2.7-ecp.1 is released.

Supported EMQX version

• EMQX 4.4.8 and later

• EMQX Enterprise 4.4.8 and later

Features 🌈

• Add a new field .spec.emqxTemplate.reloaderImage to specify the reloader image

What's Changed

• feat: add reloader image field in CRD by @Rory-Z in #779

Full Changelog: 1.2.7...1.2.7-ecp.1

EMQX Operator 2.1.2 Released

Release Note 🍻

EMQX Operator 2.1.2 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

Fixes 🛠

• Both apps.emqx.io/v1beta4 and apps.emqx.io/v2alpha1

  • Fixed an issue where EMQX Operator would frequently try to update statefulSet and deployment resources, even if there were no changes to the resources

• apps.emqx.io/v2alpha1

  • Fixed an issue where the EMQX replicant node would update before the EMQX Core node in some cases

Enhancements 🚀

• More and better documents, please check here

• Add additionalPrinterColumns for kind: EMQX and kind: EmqxEnterprise and kind: EmqxBroker, now can get more friendly information when using kubectl get emqx or kubectl get emqxenterprise or kubectl get emqxbroker

• Add event filter for EMQX operator controller, reduced runtime memory consumption

How to install/upgrade EMQX Operator 2.1.2 💡

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

EMQX Operator 2.1.2-rc.2 Released

Release Note 🍻

EMQX Operator 2.1.2 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

Fixes 🛠

• Both apps.emqx.io/v1beta4 and apps.emqx.io/v2alpha1

  • Fixed an issue where EMQX Operator would frequently try to update statefulSet and deployment resources, even if there were no changes to the resources

• apps.emqx.io/v2alpha1

  • Fixed an issue where the EMQX replicant node would update before the EMQX Core node in some cases

Enhancements 🚀

• More and better documents, please check here

• Add additionalPrinterColumns for kind: EMQX and kind: EmqxEnterprise and kind: EmqxBroker, now can get more friendly information when using kubectl get emqx or kubectl get emqxenterprise or kubectl get emqxbroker

• Add event filter for EMQX operator controller, reduced runtime memory consumption

How to install/upgrade EMQX Operator 2.1.2 💡

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

• New2.1 by @Rory-Z in #736
• fix: update emqx status before create resource by @Rory-Z in #735
• fix: fix oom by @Rory-Z in #742
• chore: add more memory for operator by @Rory-Z in #746
• Revert "chore(v2alpha1): replicant node and core node must greater th… by @Rory-Z in #743
• chore: update RELEASE.md for 2.1.2 by @Rory-Z in #749

Full Changelog: 2.1.1...2.1.2-rc.2

EMQX Operator 2.1.2-rc.1 Released

Release Note 🍻

EMQX Operator 2.1.2 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

Fixes 🛠

• Both apps.emqx.io/v1beta4 and apps.emqx.io/v2alpha1

  • Fixed an issue where EMQX Operator would frequently try to update statefulSet and deployment resources, even if there were no changes to the resources

• apps.emqx.io/v2alpha1

  • Fixed an issue where the EMQX replicant node would update before the EMQX Core node in some cases

Enhancements 🚀

• More and better documents, please check here

• Add additionalPrinterColumns for kind: EMQX and kind: EmqxEnterprise and kind: EmqxBroker, now can get more friendly information when using kubectl get emqx or kubectl get emqxenterprise or kubectl get emqxbroker

• Add event filter for EMQX operator controller, reduced runtime memory consumption

How to install/upgrade EMQX Operator 2.1.2 💡

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

EMQX Operator 2.1.1 Released

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

EMQX Operator 2.1.0 Released

Release Note 🍻

EMQX Operator 2.1.0 is released.

Supported version

• apps.emqx.io/v1beta4

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

• apps.emqx.io/v2alpha1

  • EMQX at 5.0.14 and later

Features 🌈

New API version: apps.emqx.io/v1beta4, support for EMQX 4.4 and EMQX Enterprise 4.4, please check out reference docs

• Fully compatible with apps.emqx.io/v1beta3

• The new blue-green updating feature ensures smooth migration of client connections during EMQX cluster upgrades, reducing peak server pressure, For more info please check: https://github.com/emqx/emqx-operator/blob/2.1.0/docs/en_US/tasks/configure-emqx-blueGreenUpdate.md

• EMQX Operator now uses the EMQX Bootstrap user to access the EMQX API, no longer the EMQX Dashboard user

How to upgrade EMQX Operator 2.1 from EMQX Operator 2.0 💡

Take Helm Chart as an example:

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 in EMQX Operator 2.1.1

What's Changed

• docs: update directory by @brianbinbin in #551
• docs: add some notes in getting-started doc by @Gala-R in #553
• docs: update directory and reference by @brianbinbin in #558
• Main 2.1 by @Rory-Z in #582
• docs: add blue-green update doc by @Gala-R in #583
• docs: add blue-green update doc by @Gala-R in #584
• chore(CI): add action for update dockerhub describe by @Rory-Z in #585
• add task docs by @Rory-Z in #586
• fix: fix doc error by @Gala-R in #587

Full Changelog: 2.0.3...2.1.0

EMQX Operator 2.0.3 Released

Release Note 🍻

EMQX Operator 2.0.3 is released.

Supported version

• apps.emqx.io/v1beta3

  • EMQX at 4.4.8 and later
  • EMQX Enterprise at 4.4.8 and later

• apps.emqx.io/v2alpha1

  • EMQX at 5.0.8 and later

Fixes 🛠

• Fixes a conflict when a user defines a port in the service template that duplicates an EMQX listener

• Fixes an issue with service resources not having annotation from Custom Resource resources

• Fixed incorrect DNS Name of Certificate resource in Cert Manger from EMQX Operator Helm Chart

Other changes

• In EMQX Operator Helm Chart, add extra selectors to avoid conflicts with other stuff in the same namespace

• Add More document

What's Changed

• chore(CI): update deploy docs workflows by @Rory-Z in #497
• docs: fix some minor mistakes by @brianbinbin in #518
• docs: add persistence task doc by @Gala-R in #508
• docs: add license task doc by @Gala-R in #512
• docs: add tls task doc by @Gala-R in #519
• Add extra selectors to the Services by @dshmatov in #526
• fix: inject annotations for service by @Gala-R in #527
• fix: fix error when CR have duplicate port by @Rory-Z in #531
• fix: fix webhook Certificate dnsName error by @Gala-R in #532
• chore(ci): check sts does't update by @Rory-Z in #534
• docs: add core and replicant doc by @Gala-R in #520
• docs: add configure-emqx-logs-collection doc by @brianbinbin in #533
• chore: pre release 2.0.3 by @Rory-Z in #536

Full Changelog: 2.0.2...2.0.3

EMQX Operator 2.0.2 Released

Release Note 🍻

EMQX Operator 2.0.2 is released.

Supported version

• apps.emqx.io/v1beta3

  • EMQX at 4.4.8 and later
  • EMQX Enterprise at 4.4.8 and later

• apps.emqx.io/v2alpha1

  • EMQX at 5.0.8 and later

Features 🌈

• apps.emqx.io/v1beta3

  • Add .spec.emqxTemplate.registry for EMQX Enterprise and EMQX Broker Custom Resource, the user can customize the registry that will be used for EMQX owner image, like ${registry}/emqx/emqx and ${registry}/emqx/emqx-operator-reloader, but it will not be used by other images, like sidecar container or else.

Fixes 🛠

• apps.emqx.io/v1beta3

  • Fix that adds nodePort to the ports of the headless service when .spec.emqxTemplate.serviceTemplate.spec.type is set to nodePort

  • Fix the service can not be updated when EMQX Custom Resources's replicas equal 1

  • Fix .status.condition[].lastTransitionTime is not accurate

• apps.emqx.io/v2alpha1

  • Fix the crash of the EMQX Operator when the EMQX Custom Resources's StatefulSet is not created or not found

  • Fix the error when the user-defined EMQX Custom Resources' template name

  • Fix the EMQX Custom Resources's StatefulSet always update even if the user does not change the EMQX Custom Resources

  • Fix can not update EMQX Custom Resources when not set node.cookie in .spec.bootstrapConfig

Other changes

• In apps.emqx.io/v2alpha.1, change the default value of .spec.coreTemplate.spec.replicas to 1

• In apps.emqx.io/v2alpha.1, the template metadata can not be updated when EMQX Custom Resources running

What's Changed

• chore(v2alpha1): change default replicas is 1 for core node by @Rory-Z in #388
• docs: add zh and en configuration by @brianbinbin in #392
• fix: fix headless svc NodePort invaild by @Gala-R in #395
• docs: set service type to nodePort by @Gala-R in #397
• ci: fix upgrade ci error by @Gala-R in #404
• docs: fix get-started.md error by @Gala-R in #402
• docs: adjust yaml example url by @yang-yinbo in #406
• docs: add dashboard port to full YAML file by @Gala-R in #409
• fix: fix docs search by @Swilder-M in #407
• style: rename controller package by @Rory-Z in #412
• chore: support custom webhook server secret name by @Gala-R in #413
• style: rename e2e package by @Rory-Z in #415
• chore: findReadyEmqxPod can assign container name by @Rory-Z in #416
• feat(v1beta3): take the intersection of listener in multiple emqx nodes by @Rory-Z in #417
• test(v1beta3): refactor e2e test case by @Rory-Z in #418
• ci: update actions by @Rory-Z in #420
• feat(v2alpha1): ".template.metadata" cannot be updated by @Rory-Z in #421
• fix(v2alpha1): fix user-defined template name error by @Rory-Z in #422
• chore: make the field more understandable by @brianbinbin in #424
• update actions by @Rory-Z in #427
• test: fix cts error in k8s 1.20 by @Rory-Z in #428
• docs: update deployment doc by @logo306142054 in #429
• fix(v2alpha1): fix a crash in the main application when sts is not found by @Rory-Z in #436
• docs: update aliyun deployment by @logo306142054 in #438
• fix: fix error with statefulset always be update by @Rory-Z in #439
• fix(v1beta3): fix service can not update when emqx replicas equal 1 by @Rory-Z in #448
• fix: fix status.Conditiion lastTransitionTime erro by @Gala-R in #464
• chore(apiclient): format error output by @Rory-Z in #465
• docs: add references to getting-started by @brianbinbin in #468
• chore: add "maxDescLen=0" in controller gen crd options by @Rory-Z in #473
• chore: add "crd-ref-docs" in Makefile by @Rory-Z in #474
• chore: delete "deploy/manifests/emqx-operator-controller.yaml" by @Rory-Z in #475
• chore: add k3s in compatibility test suite by @Rory-Z in #479
• chore: fix upgrade check error by @Rory-Z in #481
• feat: support customize registry for emqx and reloader image by @Gala-R in #478
• fix(v2alpha1): fix can not update EMQX resource by @Rory-Z in #482
• chore: add default labels in kustomization by @Rory-Z in #489
• fix(status): fix lose lastTransitionTime when update same condition type by @Rory-Z in #491
• chore(helm): rename cert secret name in helm value by @Rory-Z in #493
• Revert "chore(helm): rename cert secret name in helm value" by @Rory-Z in #495
• Revert "chore: support custom webhook server secret name" by @Rory-Z in #496
• chore: pre release 2.0.2 by @Rory-Z in #485

New Contributors

• @logo306142054 made their first contribution in #429

Full Changelog: 2.0.1...2.0.2