Overview
KubeDB is the Kubernetes Native Database Management Solution which simplifies and automates routine database tasks such as Provisioning, Monitoring, Upgrading, Patching, Scaling, Volume Expansion, Backup, Recovery, Failure detection, and Repair for various popular databases on private and public clouds. The databases supported by KubeDB include MongoDB, Elasticsearch, MySQL, MariaDB, Redis, PostgreSQL, FerretDB, Percona XtraDB, and Memcached. Additionally, KubeDB also supports ProxySQL, PgBouncer, Pgpool, ZooKeeper and the streaming platform Kafka, RabbitMQ. You can find the guides to all the supported databases in KubeDB . In this tutorial we will deploy RabbitMQ Cluster in Google Kubernetes Engine (GKE). We will cover the following steps:
- Install KubeDB
- Deploy RabbitMQ Cluster
- Publish & Consume Messages with RabbitMQ
Get Cluster ID
We need the cluster ID to get the KubeDB License. To get cluster ID, we can run the following command:
$ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'
8e336615-0dbb-4ae8-b72f-2e7ec34c399d
Get License
Go to Appscode License Server to get the license.txt file. For this tutorial we will use KubeDB.
Install KubeDB
We will use helm to install KubeDB. Please install helm
, if it is not already installed.
Now, let’s install KubeDB.
$ helm search repo appscode/kubedb
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2024.4.27 v2024.4.27 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.30.0 v0.30.0 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2024.4.27 v2024.4.27 KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-community v0.24.2 v0.24.2 KubeDB Community by AppsCode - Community featur...
appscode/kubedb-crd-manager v0.0.9 v0.0.9 KubeDB CRD Manager by AppsCode
appscode/kubedb-crds v2024.4.27 v2024.4.27 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.21.0 v0.21.0 KubeDB Dashboard by AppsCode
appscode/kubedb-enterprise v0.11.2 v0.11.2 KubeDB Enterprise by AppsCode - Enterprise feat...
appscode/kubedb-grafana-dashboards v2024.4.27 v2024.4.27 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-kubestash-catalog v2024.4.27 v2024.4.27 KubeStash Catalog by AppsCode - Catalog of Kube...
appscode/kubedb-metrics v2024.4.27 v2024.4.27 KubeDB State Metrics
appscode/kubedb-one v2023.12.28 v2023.12.28 KubeDB and Stash by AppsCode - Production ready...
appscode/kubedb-ops-manager v0.32.0 v0.32.1 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2024.4.27 v2024.4.27 KubeDB Opscenter by AppsCode
appscode/kubedb-provider-aws v2024.4.27 v0.7.0 A Helm chart for KubeDB AWS Provider for Crossp...
appscode/kubedb-provider-azure v2024.4.27 v0.7.0 A Helm chart for KubeDB Azure Provider for Cros...
appscode/kubedb-provider-gcp v2024.4.27 v0.7.0 A Helm chart for KubeDB GCP Provider for Crossp...
appscode/kubedb-provisioner v0.45.0 v0.45.1 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.21.0 v0.21.0 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui v2024.5.17 0.6.8 A Helm chart for Kubernetes
appscode/kubedb-ui-server v2021.12.21 v2021.12.21 A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server v0.21.0 v0.21.1 KubeDB Webhook Server by AppsCode
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2024.4.27 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt \
--set global.featureGates.RabbitMQ=true \
--wait --burst-limit=10000 --debug
Let’s verify the installation:
$ kubectl get pods --all-namespaces -l "app.kubernetes.io/instance=kubedb"
NAMESPACE NAME READY STATUS RESTARTS AGE
kubedb kubedb-kubedb-autoscaler-69b46c5c7b-s85w2 1/1 Running 0 3m2s
kubedb kubedb-kubedb-ops-manager-6f8bd5b9c9-2klvr 1/1 Running 0 3m2s
kubedb kubedb-kubedb-provisioner-5d778764bb-pd79k 1/1 Running 0 3m2s
kubedb kubedb-kubedb-webhook-server-fbbfd96bd-479qv 1/1 Running 0 3m2s
kubedb kubedb-petset-operator-5d94b4ddb8-lwrsd 1/1 Running 0 3m2s
kubedb kubedb-petset-webhook-server-5f6c89d8c8-lfxvf 2/2 Running 0 3m2s
kubedb kubedb-sidekick-5d9947bd9-gs4vh 1/1 Running 0 3m2s
We can list the CRD Groups that have been registered by the operator by running the following command:
$ kubectl get crd -l app.kubernetes.io/name=kubedb
NAME CREATED AT
connectclusters.kafka.kubedb.com 2024-05-31T09:50:14Z
connectors.kafka.kubedb.com 2024-05-31T09:50:14Z
druidversions.catalog.kubedb.com 2024-05-31T09:47:40Z
elasticsearchautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:11Z
elasticsearchdashboards.elasticsearch.kubedb.com 2024-05-31T09:50:11Z
elasticsearches.kubedb.com 2024-05-31T09:50:10Z
elasticsearchopsrequests.ops.kubedb.com 2024-05-31T09:50:11Z
elasticsearchversions.catalog.kubedb.com 2024-05-31T09:47:40Z
etcdversions.catalog.kubedb.com 2024-05-31T09:47:40Z
ferretdbversions.catalog.kubedb.com 2024-05-31T09:47:40Z
kafkaautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:14Z
kafkaconnectorversions.catalog.kubedb.com 2024-05-31T09:47:40Z
kafkaopsrequests.ops.kubedb.com 2024-05-31T09:50:14Z
kafkas.kubedb.com 2024-05-31T09:50:14Z
kafkaversions.catalog.kubedb.com 2024-05-31T09:47:40Z
mariadbarchivers.archiver.kubedb.com 2024-05-31T09:50:17Z
mariadbautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:17Z
mariadbdatabases.schema.kubedb.com 2024-05-31T09:50:17Z
mariadbopsrequests.ops.kubedb.com 2024-05-31T09:50:17Z
mariadbs.kubedb.com 2024-05-31T09:50:17Z
mariadbversions.catalog.kubedb.com 2024-05-31T09:47:40Z
memcachedversions.catalog.kubedb.com 2024-05-31T09:47:40Z
mongodbarchivers.archiver.kubedb.com 2024-05-31T09:50:20Z
mongodbautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:20Z
mongodbdatabases.schema.kubedb.com 2024-05-31T09:50:20Z
mongodbopsrequests.ops.kubedb.com 2024-05-31T09:50:20Z
mongodbs.kubedb.com 2024-05-31T09:50:20Z
mongodbversions.catalog.kubedb.com 2024-05-31T09:47:40Z
mssqlserverversions.catalog.kubedb.com 2024-05-31T09:47:40Z
mysqlarchivers.archiver.kubedb.com 2024-05-31T09:50:24Z
mysqlautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:24Z
mysqldatabases.schema.kubedb.com 2024-05-31T09:50:24Z
mysqlopsrequests.ops.kubedb.com 2024-05-31T09:50:24Z
mysqls.kubedb.com 2024-05-31T09:50:24Z
mysqlversions.catalog.kubedb.com 2024-05-31T09:47:40Z
perconaxtradbversions.catalog.kubedb.com 2024-05-31T09:47:40Z
pgbouncerversions.catalog.kubedb.com 2024-05-31T09:47:40Z
pgpoolversions.catalog.kubedb.com 2024-05-31T09:47:40Z
postgresarchivers.archiver.kubedb.com 2024-05-31T09:50:27Z
postgresautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:27Z
postgresdatabases.schema.kubedb.com 2024-05-31T09:50:27Z
postgreses.kubedb.com 2024-05-31T09:50:27Z
postgresopsrequests.ops.kubedb.com 2024-05-31T09:50:27Z
postgresversions.catalog.kubedb.com 2024-05-31T09:47:40Z
proxysqlversions.catalog.kubedb.com 2024-05-31T09:47:40Z
publishers.postgres.kubedb.com 2024-05-31T09:50:27Z
rabbitmqautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:30Z
rabbitmqopsrequests.ops.kubedb.com 2024-05-31T09:50:30Z
rabbitmqs.kubedb.com 2024-05-31T09:50:30Z
rabbitmqversions.catalog.kubedb.com 2024-05-31T09:47:40Z
redisautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:34Z
redises.kubedb.com 2024-05-31T09:50:33Z
redisopsrequests.ops.kubedb.com 2024-05-31T09:50:34Z
redissentinelautoscalers.autoscaling.kubedb.com 2024-05-31T09:50:34Z
redissentinelopsrequests.ops.kubedb.com 2024-05-31T09:50:34Z
redissentinels.kubedb.com 2024-05-31T09:50:34Z
redisversions.catalog.kubedb.com 2024-05-31T09:47:40Z
singlestoreversions.catalog.kubedb.com 2024-05-31T09:47:40Z
solrversions.catalog.kubedb.com 2024-05-31T09:47:40Z
subscribers.postgres.kubedb.com 2024-05-31T09:50:27Z
zookeeperversions.catalog.kubedb.com 2024-05-31T09:47:40Z
Deploy RabbitMQ Cluster
We are going to Deploy RabbitMQ Cluster by using KubeDB. First, let’s create a Namespace in which we will deploy RabbitMQ.
$ kubectl create namespace demo
namespace/demo created
Here is the yaml of the RabbitMQ we are going to use:
apiVersion: kubedb.com/v1alpha2
kind: RabbitMQ
metadata:
name: rabbitmq-cluster
namespace: demo
spec:
version: "3.12.12"
replicas: 3
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
storageClassName: standard
storageType: Durable
terminationPolicy: WipeOut
Let’s save this yaml configuration into rabbitmq-cluster.yaml
Then apply the above RabbitMQ yaml,
$ kubectl apply -f rabbitmq-cluster.yaml
rabbitmq.kubedb.com/rabbitmq-cluster created
In this yaml,
spec.replicasis used to provide the number of required replicas or, peers for intended rabbitmq cluster.spec.versionfield specifies the version of RabbitMQ. Here, we are using RabbitMQ3.12.12. You can list the KubeDB supported versions of RabbitMQ by running$ kubectl get rabbitmqversionscommand.spec.storage.storageClassNameis the name of the StorageClass used to provision PVCs.spec.terminationPolicyfield is Wipeout means it will be deleted without restrictions. It can also be “Halt”, “Delete” and “DoNotTerminate”.
Once these are handled correctly and the RabbitMQ object is deployed, you will see that the following resources are created:
$ kubectl get all -n demo
NAME READY STATUS RESTARTS AGE
pod/rabbitmq-cluster-0 1/1 Running 0 91s
pod/rabbitmq-cluster-1 1/1 Running 0 29s
pod/rabbitmq-cluster-2 1/1 Running 0 22s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/rabbitmq-cluster ClusterIP 10.96.92.2 <none> 15672/TCP,5672/TCP 94s
service/rabbitmq-cluster-pods ClusterIP None <none> 4369/TCP,25672/TCP 94s
NAME TYPE VERSION AGE
appbinding.appcatalog.appscode.com/rabbitmq-cluster kubedb.com/rabbitmq 3.12.12 91s
Let’s check if the rabbitmq-cluster is ready to use,
$ kubectl get rabbitmq -n demo rabbitmq-cluster
NAME TYPE VERSION STATUS AGE
rabbitmq-cluster kubedb.com/v1alpha2 3.12.12 Ready 119s
We have successfully deployed RabbitMQ in GKE. Now we can exec into the container to use the database.
Connect with RabbitMQ UI
We will use port forwarding to connect with RabbitMQ.
Port-forward the Service
KubeDB will create few Services to connect with the RabbitMQ. Let’s check the Services by following command,
$ kubectl get service -n demo
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
rabbitmq-cluster ClusterIP 10.96.92.2 <none> 15672/TCP,5672/TCP 4m52s
rabbitmq-cluster-pods ClusterIP None <none> 4369/TCP,25672/TCP 4m52s
Here, we are going to use rabbitmq-cluster Service to connect with the database. Now, let’s port-forward the rabbitmq-cluster Service to the port 15672 to local machine:
$ kubectl port-forward -n demo svc/rabbitmq-cluster 15672
Forwarding from 127.0.0.1:15672 -> 15672
Forwarding from [::1]:15672 -> 15672
Now, our RabbitMQ UI is accessible at localhost:15672.
Accessing RabbitMQ Through UI
To access RabbitMQ through the UI, we first need the login credentials.
Get the Credentials
KubeDB create some Secrets for the database. Let’s check which Secrets have been created by KubeDB for our rabbitmq-cluster.
$ kubectl get secret -n demo
NAME TYPE DATA AGE
rabbitmq-cluster-admin-cred kubernetes.io/basic-auth 2 9m8s
rabbitmq-cluster-config Opaque 2 9m8s
rabbitmq-cluster-erlang-cookie Opaque 1 9m8s
Now, we can use rabbitmq-cluster-admin-cred which contains the admin level credentials to connect with the RabbitMQ. You can obtain these credentials by running the following commands:
$ kubectl get secret -n demo rabbitmq-cluster-admin-cred -o jsonpath='{.data.username}' | base64 -d
admin
$ kubectl get secret -n demo rabbitmq-cluster-admin-cred -o jsonpath='{.data.password}' | base64 -d
eA)BA;gzeK)yM6)T
With the credentials in hand, open your web browser and navigate to http://localhost:15672/. You will see the RabbitMQ login panel. Enter the username admin and the password eA)BA;gzeK)yM6)T to access the RabbitMQ UI.
Once logged in, click on the Queues & Streams section to manage queues. Here, we are going to add a new queue named test-queue.
After creating the queue, click on test-queue to view its overview. This section provides various details and actions for managing the queue.
Next, navigate to the Publish message section to publish some test messages to test-queue. Enter the message details in the payload field and click the Publish message button to publish the message.
To retrieve the messages you have just published, go to the Get messages section of test-queue. Click the Get Message(s) button, and the messages will be fetched from the queue.
You can repeat the process of publishing and getting messages to see how RabbitMQ handles them.
Finally, the statistics in the overview section of test-queue will show the number of messages and other relevant information after your interactions.
So, we have deployed RabbitMQ on Kubernetes and accessed the RabbitMQ UI for publishing and consuming messages. More information about Deploy & Manage RabbitMQ on Kubernetes can be found in RabbitMQ Kubernetes .
We have made a in depth tutorial on Provision and Manage RabbitMQ Cluster on Kubernetes using KubeDB. You can have a look into the video below:
Support
To speak with us, please leave a message on our website .
To receive product announcements, follow us on X .
To watch tutorials of various Production-Grade Kubernetes Tools Subscribe our YouTube channel.
More about RabbitMQ on Kubernetes
If you have found a bug with KubeDB or want to request for new features, please file an issue .