messaging-topology-operator

README

RabbitMQ Messaging Topology Kubernetes Operator

Kubernetes operator to allow developers to create and manage RabbitMQ messaging topologies within a RabbitMQ cluster using a declarative Kubernetes API. A Messaging topology is the collection of objects such as exchanges, queues, bindings and policies that provides specific messaging or streaming scenario. This operator is used with RabbitMQ clusters deployed via the RabbitMQ Cluster Kubernetes Operator. This repository contains custom controllers and custom resource definitions (CRDs) enabling a declarative API for RabbitMQ messaging topologies.

Quickstart

Before deploying Messaging Topology Operator, you need to have:

1. A Running k8s cluster
2. RabbitMQ Cluster Operator installed in the k8s cluster
3. A RabbitMQ cluster deployed using the Cluster Operator

If you have cert-manager 1.2.0 or above installed in your k8s cluster, and kubectl configured to access your running k8s cluster, you can then run the following command to install the Messaging Topology Operator:

kubectl apply -f https://github.com/rabbitmq/messaging-topology-operator/releases/latest/download/messaging-topology-operator-with-certmanager.yaml

If you do not have cert-manager installed in your k8s cluster, you will need to generate certificates used by admission webhooks yourself and include them in the operator and webhooks manifests. You can follow this doc.

You can create RabbitMQ resources:

1. Queue
2. Exchange
3. Binding
4. User
5. Vhost
6. Policy
7. Permissions
8. Federations
9. Shovels

Documentation

Messaging Topology Operator is covered in several guides:

• Operator overview
• Installation
• Using Messaging Topology Operator
• TLS
• Troubleshooting Messaging Topology Operator

In addition, a number of examples, Operator API reference, and a quick tutorial can be found in this repository.

The doc guides are open source. The source can be found in the RabbitMQ website repository under site/kubernetes.

RabbitMQCluster requirements

Messaging Topology Operator is tested with the latest release of RabbitMQ Cluster Operator. It uses the generated default user secret from RabbitmqCluster (set in rabbitmqcluster.status.binding) to authenticate with RabbitMQ server. If your RabbitmqCluster is deployed with import definitions or provided default user credentials, the default user secret from rabbitmqcluster.status.binding may not be correct and Messaging Topology Operator will fail with authentication error. If your RabbitmqCluster is configured to serve management traffic over TLS, you may need to configure the Messaging Topology Operator to trust the CA that signed the server's certificates. For more information, see this doc.

Contributing

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

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

License

Licensed under the MPL, same as RabbitMQ server and cluster operator.

Copyright

Copyright 2021-2022 VMware, Inc. All Rights Reserved.