Add RabbitMQ complete documentation

Signed-off-by: raihankhan <[email protected]>
kubedb · Sep 16, 2024 · 6358fe0 · 6358fe0
1 parent 2fe7040
commit 6358fe0
Show file tree

Hide file tree

Showing 54 changed files with 6,846 additions and 121 deletions.
diff --git a/docs/examples/rabbitmq/cluster/rabbit-custom-config.yaml b/docs/examples/rabbitmq/cluster/rabbit-custom-config.yaml
@@ -0,0 +1,17 @@
+apiVersion: kubedb.com/v1alpha2
+kind: RabbitMQ
+metadata:
+  name: rm-cluster
+  namespace: demo
+spec:
+  version: "3.13.2"
+  storageType: Durable
+  storage:
+    storageClassName: "standard"
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 1Gi
+  configSecret:
+    name: rabbit-custom-config
diff --git a/docs/examples/rabbitmq/cluster/rabbitmq-cluster.yaml b/docs/examples/rabbitmq/cluster/rabbitmq-cluster.yaml
@@ -0,0 +1,17 @@
+apiVersion: kubedb.com/v1alpha2
+kind: RabbitMQ
+metadata:
+  name: rabbitmq
+  namespace: demo
+spec:
+  version: "3.13.2"
+  replicas: 3
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 1Gi
+    storageClassName: standard
+  storageType: Durable
+  deletionPolicy: WipeOut
diff --git a/docs/examples/rabbitmq/opsrequests/rabbit-reconfigure-with-secret.yaml b/docs/examples/rabbitmq/opsrequests/rabbit-reconfigure-with-secret.yaml
@@ -0,0 +1,14 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: RabbitMQOpsRequest
+metadata:
+  name: reconfigure-rm-cluster
+  namespace: demo
+spec:
+  type: Reconfigure
+  databaseRef:
+    name: rm-cluster
+  configuration:
+    configSecret:
+      name: new-custom-config
+  timeout: 5m
+  apply: IfReady
diff --git a/docs/examples/rabbitmq/opsrequests/rabbitmq-reconfigure-apply.yaml b/docs/examples/rabbitmq/opsrequests/rabbitmq-reconfigure-apply.yaml
@@ -0,0 +1,15 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: RabbitMQOpsRequest
+metadata:
+  name: reconfigure-apply
+  namespace: demo
+spec:
+  type: Reconfigure
+  databaseRef:
+    name: rm-cluster
+  configuration:
+    applyConfig:
+      rabbitmq.conf: |
+        default_vhost = /newvhost
+  timeout: 5m
+  apply: IfReady
diff --git a/docs/examples/rabbitmq/quickstart/quickstart.yaml b/docs/examples/rabbitmq/quickstart/quickstart.yaml
@@ -4,7 +4,7 @@ metadata:
   name: rm-quickstart
   namespace: demo
 spec:
-  version: "3.12.12"
+  version: "3.13.2"
   replicas: 3
   storage:
     accessModes:

diff --git a/docs/guides/rabbitmq/README.md b/docs/guides/rabbitmq/README.md
@@ -16,34 +16,36 @@ aliases:
 
 # Overview 
 
-RabbitMQ is a robust and flexible open-source message broker software that facilitates communication between distributed applications. It implements the Advanced Message Queuing Protocol (AMQP) standard, ensuring reliable messaging across various platforms and languages. With its support for multiple messaging protocols and delivery patterns, RabbitMQ enables seamless integration and scalability for modern microservices architectures. It provides features such as message persistence, clustering, and high availability, making it a preferred choice for handling asynchronous communication and decoupling components in enterprise systems.
+RabbitMQ is a robust and flexible open-source message broker software that facilitates communication between distributed applications. It implements the Advanced Message Queuing Protocol (AMQP) standard, ensuring reliable messaging across various platforms and languages. With its support for multiple messaging protocols (MQTT, STOMP etc.) and delivery patterns (Fanout, Direct, Exchange etc.), RabbitMQ enables seamless integration and scalability for modern microservices architectures. It provides features such as message persistence, clustering, and high availability, making it a preferred choice for handling asynchronous communication and decoupling components in enterprise systems.
 
 ## Supported RabbitMQ Features
 
-| Features                                           | Availability |
-|----------------------------------------------------|:------------:|
-| Clustering                                         |   &#10003;   |
-| Authentication & Authorization                     |   &#10003;   |
-| Custom Configuration                               |   &#10003;   |
-| Monitoring using Prometheus and Grafana            |   &#10003;   |
-| Builtin Prometheus Discovery                       |   &#10003;   |
-| Using Prometheus operator                          |   &#10003;   |
-| Externally manageable Auth Secret                  |   &#10003;   |
-| Reconfigurable Health Checker                      |   &#10003;   |
-| Persistent volume                                  |   &#10003;   | 
-| Dashboard ( Management UI )                        |   &#10003;   |
-| Grafana Dashboards (Alerts and Monitoring)         |   &#10003;   |
-| Custom Plugin configurations                       |   &#10003;   |
-| Pre-Enabled utility plugins ( Shovel, Federation ) |   &#10003;   |
-| Automatic Vertical Scaling                         |   &#10003;   |
-| Automatic Volume Expansion                         |   &#10003;   |
-| Autoscaling ( Compute resources & Storage )        |   &#10003;   |
-
+| Features                                                      | Availability |
+|---------------------------------------------------------------|:------------:|
+| Clustering                                                    |   &#10003;   |
+| Custom Configuration                                          |   &#10003;   |
+| Custom Plugin configurations                                  |   &#10003;   |
+| Monitoring using Prometheus and Grafana                       |   &#10003;   |
+| Builtin Prometheus Discovery                                  |   &#10003;   |
+| Operator managed Prometheus Discovery                         |   &#10003;   |
+| Authentication & Authorization (TLS)                          |   &#10003;   |
+| Externally manageable Auth Secret                             |   &#10003;   |
+| Persistent volume                                             |   &#10003;   |
+| Grafana Dashboards (Alerts and Monitoring)                    |   &#10003;   |
+| Pre-Enabled Dashboard ( Management UI )                       |   &#10003;   |
+| Pre-Enabled utility plugins ( Shovel, Federation )            |   &#10003;   |
+| Pre-Enabled Protocols with web dispatch ( AMQP, MQTT, STOMP ) |   &#10003;   |
+| Automated Vertical & Horizontal Scaling                       |   &#10003;   |
+| Automated Volume Expansion                                    |   &#10003;   |
+| Autoscaling ( Compute resources & Storage )                   |   &#10003;   |
+| Reconfigurable Health Checker                                 |   &#10003;   |
+| Reconfigurable TLS Certificates (Add, Remove, Rotate, Update) |   &#10003;   |
 
 ## Supported RabbitMQ Versions
 
 KubeDB supports the following RabbitMQ Versions.
 - `3.12.12`
+- `3.13.2`
 
 ## Life Cycle of a RabbitMQ Object
 

diff --git a/docs/guides/rabbitmq/_index.md b/docs/guides/rabbitmq/_index.md
@@ -2,8 +2,7 @@
 title: RabbitMQ
 menu:
   docs_{{ .version }}:
-    identifier: guides-rabbitmq
-    name: RabbitMQ
+    identifier: rm-guides
     parent: guides
     weight: 10
 menu_name: docs_{{ .version }}

diff --git a/docs/guides/rabbitmq/autoscaler/_index.md b/docs/guides/rabbitmq/autoscaler/_index.md
@@ -0,0 +1,10 @@
+---
+title: Autoscaling
+menu:
+  docs_{{ .version }}:
+    identifier: rm-autoscaling
+    name: Autoscaling
+    parent: rm-guides
+    weight: 46
+menu_name: docs_{{ .version }}
+---
diff --git a/docs/guides/rabbitmq/autoscaler/compute/_index.md b/docs/guides/rabbitmq/autoscaler/compute/_index.md
@@ -0,0 +1,10 @@
+---
+title: Compute Autoscaling
+menu:
+  docs_{{ .version }}:
+    identifier: rm-autoscaling-compute
+    name: Compute Autoscaling
+    parent: rm-autoscaling
+    weight: 46
+menu_name: docs_{{ .version }}
+---