Skip to content

Commit

Permalink
Add RabbitMQ doc
Browse files Browse the repository at this point in the history
Signed-off-by: raihankhan <[email protected]>
  • Loading branch information
raihankhan committed May 8, 2024
1 parent 062052a commit 257be4b
Show file tree
Hide file tree
Showing 9 changed files with 546 additions and 1 deletion.
32 changes: 32 additions & 0 deletions docs/examples/rabbitmq/quickstart/quickstart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
apiVersion: kubedb.com/v1alpha2
kind: RabbitMQ
metadata:
name: rm-quickstart
namespace: demo
spec:
version: "3.12.12"
replicas: 3
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
storageClassName: standard
storageType: Durable
terminationPolicy: WipeOut # DoNotTerminate(blocks deletion), Halt( retains pvc,secret), Delete (retains secret)
podTemplate:
spec:
containers:
- name: rabbitmq
resources:
requests:
cpu: "0.5"
memory: "1Gi"
limits:
cpu: "2"
memory: "2Gi"
serviceTemplates:
- alias: primary
spec:
type: LoadBalancer
4 changes: 3 additions & 1 deletion docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ aliases:
Guides to show you how to perform tasks with KubeDB:
- [Druid](/docs/guides/kafka/README.md). Shows how to manage Druid using KubeDB.
- [Elasticsearch](/docs/guides/elasticsearch/README.md). Shows how to manage Elasticsearch & OpenSearch using KubeDB.
- [Kafka](/docs/guides/kafka/README.md). Shows how to manage Kafka using KubeDB.
- [MariaDB](/docs/guides/mariadb). Shows how to manage MariaDB using KubeDB.
- [Memcached](/docs/guides/memcached/README.md). Shows how to manage Memcached using KubeDB.
- [Microsoft SQL Server](/docs/guides/mssqlserver/README.md). Shows how to manage Microsoft SQL Server using KubeDB.
Expand All @@ -30,6 +29,9 @@ Guides to show you how to perform tasks with KubeDB:
- [PostgreSQL](/docs/guides/postgres/README.md). Shows how to manage PostgreSQL using KubeDB.
- [ProxySQL](/docs/guides/proxysql/README.md). Shows how to manage ProxySQL using KubeDB.
- [Redis](/docs/guides/redis/README.md). Shows how to manage Redis using KubeDB.
- [RabbitMQ](/docs/guides/rabbitmq/README.md). Shows how to manage RabbitMQ using KubeDB.
- [Kafka](/docs/guides/kafka/README.md). Shows how to manage Kafka using KubeDB.
- [ZooKeeper](/docs/guides/zookeeper/README.md). Shows how to manage ZooKeeper using KubeDB.
- [SingleStore](/docs/guides/singlestore/README.md). Shows how to manage SingleStore using KubeDB.
- [Solr](/docs/guides/solr/README.md). Shows how to manage Solr using KubeDB.
- [ZooKeeper](/docs/guides/zookeeper/README.md). Shows how to manage ZooKeeper using KubeDB.
61 changes: 61 additions & 0 deletions docs/guides/rabbitmq/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: RabbitMQ
menu:
docs_{{ .version }}:
identifier: guides-rabbitmq-readme
name: RabbitMQ
parent: guides-rabbitmq
weight: 10
menu_name: docs_{{ .version }}
section_menu_id: guides
url: /docs/{{ .version }}/guides/rabbitmq/
aliases:
- /docs/{{ .version }}/guides/rabbitmq/README/
---
> New to KubeDB? Please start [here](/docs/README.md).
# 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.

## 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; |


## Supported RabbitMQ Versions

KubeDB supports the following RabbitMQ Versions.
- `3.12.12`

## Life Cycle of a RabbitMQ Object

<!---
ref : https://cacoo.com/diagrams/4PxSEzhFdNJRIbIb/0281B
--->

<p text-align="center">
<img alt="lifecycle" src="/docs/guides/rabbitmq/images/rabbitmq-lifecycle.png" >
</p>

## User Guide

- [Quickstart RabbitMQ](/docs/guides/rabbitmq/quickstart/quickstart.md) with KubeDB Operator.
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
10 changes: 10 additions & 0 deletions docs/guides/rabbitmq/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: RabbitMQ
menu:
docs_{{ .version }}:
identifier: guides-rabbitmq
name: RabbitMQ
parent: guides
weight: 20
menu_name: docs_{{ .version }}
---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/guides/rabbitmq/quickstart/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: RabbitMQ Quickstart
menu:
docs_{{ .version }}:
identifier: rm-quickstart-rabbitmq
name: Quickstart
parent: guides-rabbitmq
weight: 10
menu_name: docs_{{ .version }}
---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 257be4b

Please sign in to comment.