Repository files navigation

Kubernetes operator to deploy and manageRabbitMQ clusters. This repository contains acustom controller andcustom resource definition (CRD) designed for the lifecycle (creation, upgrade, graceful shutdown) of a RabbitMQ cluster.

If you have a running Kubernetes cluster andkubectl configured to access it, run the following command to install the operator:

kubectl apply -f https://github.com/rabbitmq/cluster-operator/releases/latest/download/cluster-operator.yml

Then you can deploy a RabbitMQ cluster:

kubectl apply -f https://raw.githubusercontent.com/rabbitmq/cluster-operator/main/docs/examples/hello-world/rabbitmq.yaml

RabbitMQ Cluster Kubernetes Operator is covered by several guides:

• Operator overview
• Deploying an operator
• Deploying a RabbitMQ cluster
• Monitoring the cluster
• Troubleshooting operator deployments

In addition, a number ofexamples can be found in this repository.

The doc guides are open source. The source can be found in theRabbitMQ website repositoryundersite/kubernetes.

The operator deploys RabbitMQ3.12.2 by default, and supports versions from3.9.9 upwards. The operator requires Kubernetes1.19 or newer.

RabbitMQ Cluster Kubernetes Operator follows non-strictsemver.

The versioning guidelines document contains guidelineson how we implement non-strict semver. The version number MAY or MAY NOT follow the semver rules. Hence, we highly recommend to readthe release notes to understand the changes and their potential impact for any release.

This project follows the typical GitHub pull request model. Before starting any work, please either comment on anexisting issue, or file a new one.

Please readcontribution guidelines if you are interested in contributing to this project.

To release a new version of the Cluster Operator, create a versioned tag (e.g.v1.2.3) of the repo, and the release pipeline willgenerate a new draft release, alongside release artefacts.

Licensed under the MPL, same as RabbitMQ server.

Copyright 2020-2023 VMware, Inc. All Rights Reserved.