> ## Documentation Index
> Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# RabbitMQ

> RabbitMQ message broker via the community groundhog2k Helm chart (official docker.io/rabbitmq image)

Qovery creates it as a Helm release on the environment's own cluster, as a [Blueprint](https://www.qovery.com/docs/configuration/blueprints.md) service in one of your environments.

| | |
| - | - |
| Catalog name | `helm-rabbitmq` |
| Category | Messaging & Streaming |
| Provider | HELM |
| Engine | helm |
| Major versions (latest release) | `4` (2.0.4) |
| Source | [HELM/rabbitmq/4](https://github.com/Qovery/service-catalog/tree/HELM/rabbitmq/4/2.0.4/HELM/rabbitmq/4) |

> [!TIP]
>
> **New to this?** You don't need to know Kubernetes or Helm. Qovery installs RabbitMQ on your cluster with Helm and runs it for you: you fill in a form, or paste the prompt below into your coding agent. The values it publishes, listed under Outputs, reach your other services as environment variables. Qovery tells you when a newer version of the Blueprint is available. Check the requirements in the Reference section before you start, and try it first in a development environment.

## Create it

> [tab] Console
>
> 1. Open the environment, then **New service** › **Blueprint**.
> 2. Find **RabbitMQ** in the catalog and pick the major version.
> 3. Fill in the variables. Required ones are marked; the others use their defaults.
> 4. Create the service, and deploy it now or later.

> [tab] CLI and API
>
> List the catalog to get the latest tag, then create the service from it. `qovery api` signs the requests with your CLI session.
>
> ```bash theme={null}
> ORG_ID="REPLACE_WITH_ORGANIZATION_ID"
> ENV_ID="REPLACE_WITH_ENVIRONMENT_ID"
>
> qovery api "organization/$ORG_ID/blueprint/catalog" | jq '.. | objects | select(.name? == "helm-rabbitmq")'
>
> cat > blueprint.json <<'EOF'
> {
>   "name": "helm-rabbitmq",
>   "tag": "HELM/rabbitmq/4/2.0.4",
>   "icon": "app://qovery-console/rabbitmq",
>   "variables": [
>     {
>       "name": "password",
>       "value": "REPLACE_WITH_PASSWORD",
>       "is_secret": true
>     }
>   ]
> }
> EOF
> BLUEPRINT_ID=$(qovery api "environment/$ENV_ID/blueprint" --method POST --input - < blueprint.json | jq -r .id)
> rm blueprint.json   # it can hold secret values
> qovery api "blueprint/$BLUEPRINT_ID/deploy" --method POST
> qovery api "blueprint/$BLUEPRINT_ID"   # status of the latest deployment
> ```
>
> Replace each `REPLACE_WITH_` value. Add optional variables to `variables` the same way.

> [tab] Coding agent
>
> Paste this into Claude Code, Cursor, Codex or another coding agent with the [Qovery agent skills](https://www.qovery.com/docs/getting-started/quickstart/agent-skills.md) installed (`curl -fsSL https://skill.qovery.com/install.sh | bash`).
>
> ```text Prompt wrap theme={null}
> Add the Qovery Blueprint RabbitMQ (helm-rabbitmq) to one of my Qovery environments and deploy it. Ask me for password.
> Ask me before deploying to a production environment.
> Docs: https://www.qovery.com/docs/configuration/blueprints/helm-rabbitmq.md
> ```

You don't add any file to your repository. Qovery creates the Blueprint from the Console or the API.

## Variables and outputs

Generated from `qbm.yml` at `HELM/rabbitmq/4/2.0.4`, the manifest the Console form is built from.

> [accordion] All 4 variables
>
> | Name | Type | Required | Default | Secret | Description |
> | - | - | - | - | - | - |
> | `replica_count` | number | | `1` | | RabbitMQ pods, 1–10 |
> | `username` | string | | `user` | | Letters, digits, dots, hyphens, underscores; max 64 chars. |
> | `password` | string | Yes | | Yes | 10–128 chars. |
> | `memory_limit` | string | | `512Mi` | | Kubernetes quantity, e.g. 512Mi or 1Gi |

Outputs become environment variables that other services in the environment can use. By default Qovery also creates an alias for each output, prefixed with the Blueprint's name; see [Aliases Qovery creates for outputs](https://www.qovery.com/docs/configuration/environment-variables.md#aliases-qovery-creates-for-outputs) for the naming rules and the cases where no alias is created.

> [accordion] All 2 outputs
>
> | Name | Secret | Description |
> | - | - | - |
> | `rabbitmq_host` | | RabbitMQ service hostname |
> | `rabbitmq_port` | | RabbitMQ AMQP port |

## Reference

From the Blueprint's [README](https://github.com/Qovery/service-catalog/blob/HELM/rabbitmq/4/2.0.4/HELM/rabbitmq/4/README.md).

Deploys RabbitMQ message broker via the community [groundhog2k](https://github.com/groundhog2k/helm-charts) Helm chart, which wraps the official `docker.io/rabbitmq` image. Data is not persisted — pod restarts will clear queues and messages. When `replica_count > 1`, the replicas form a cluster via Kubernetes peer discovery.

### Variables

| Name | Type | Required | Sensitive | Default | Description |
| - | - | - | - | - | - |
| `replica_count` | number | no | | `1` | Number of RabbitMQ replicas. Min 1, max 10. |
| `username` | string | no | | `user` | RabbitMQ default username. Use letters, digits, hyphens, underscores, and dots only. |
| `password` | string | yes | yes | — | RabbitMQ authentication password (min 10 chars recommended). Also used as the Erlang cluster cookie. |
| `memory_limit` | string | no | | `512Mi` | Memory limit for RabbitMQ pods. Must be a valid Kubernetes quantity (e.g. `512Mi`, `1Gi`). |

### Outputs

| Name | Description |
| - | - |
| `rabbitmq_host` | RabbitMQ service hostname |
| `rabbitmq_port` | RabbitMQ AMQP port |


## Related topics

- [Application](https://www.qovery.com/docs/configuration/application.md)
- [Amazon MQ for RabbitMQ](https://www.qovery.com/docs/configuration/blueprints/aws-amazon-mq-rabbitmq.md)
- [Blueprints](https://www.qovery.com/docs/configuration/blueprints.md)
- [HPA vs KEDA: Choosing an Autoscaling Mode](https://www.qovery.com/docs/getting-started/guides/advanced-tutorials/hpa-vs-keda-autoscaling.md)
- [Optimize](https://www.qovery.com/docs/getting-started/guides/qovery-101/optimize.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.