Component

core/messaging/rabbitmq

A RabbitMQ message broker speaking the AMQP protocol, persisting queues and messages durably. Exports its host and AMQP port to consumers via the uses topology. Self-hosted, it renders as a stateful workload with a persistent volume, by a Helm Recipe (Workload synthesis to native Kubernetes resources), a Compose Recipe (local development), and a controller-driven Helm Recipe that emits a RabbitmqCluster custom resource for the RabbitMQ Cluster Operator. Reach for the synthesis Recipe on a cluster that runs no RabbitMQ control plane, and for the controller-driven one where the control plane is in place and the cluster should own upgrades, rolling restarts and credential rotation. Broker access always requires credentials: on these Recipes the password slot is optional, and each falls back to a deterministic inline development default so the render stays reproducible. Reach for the rabbitmq-amazon-mq Recipes, on terraform and on CloudFormation, where the broker is an Amazon MQ broker in the operator's AWS account. Amazon MQ serves AMQP over TLS alone, on 5671, published as protocol amqps, and requires a password: a core/random-password attachment, without which the build halts. It runs RabbitMQ 4.3, 4.2 and 3.13, so the engine_version default halts there. The self-hosted brokers serve their own metrics, published with `values.metrics_enabled` true; the Amazon MQ Recipes halt on true.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:f4c0aefbfcb8b053e435e79985622412924a5ffdd575b3b96dcb804ba583bff4
Published
2026-11-10T10:12:32Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officialapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:e0e8d7037c8e13c83e681972e42ec3e0bcaf2b0c1cf48b972365c9c6c3a50d28

Reference at this version

oci://hub.aggrega.ai/component/core/messaging/rabbitmq:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
userstringusernoApplication user the broker provisions on startup. The matching password comes from the password credential slot. On Amazon MQ it is the broker's one administrative user, named with 2 to 100 letters, digits, dashes, periods and underscores; the Amazon MQ Recipes refuse any other name, and guest.
metrics_enabledbooleanfalsenoPublishes where the broker's own metrics are, in the Prometheus format — the address as `metrics_endpoint`, or, on a controller-driven cluster of more than one node, the Service a scraper discovers every node behind — putting their port on the Service where a realization needs it; while false those keys are empty. The metrics port checks no caller, so anything that reaches it can read them. The Amazon MQ realizations halt the build on true, since the service shows its metrics only to a scraper presenting the broker's own credentials.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)5672noAMQP listen port. Most operators should omit this and let the Recipe assign the default (5672). The Amazon MQ realizations do not read it — the service serves AMQP over TLS on 5671 alone, which they publish as port — and halt the build on any value other than this default.
management_portinteger (min 1024, max 65535)15672noManagement HTTP API and dashboard port. Most operators should omit this and let the Recipe assign the default (15672). The Amazon MQ realizations do not read it — the service serves the management interface at an address of its own — and halt the build on any value other than this default.
engine_versionstring4.1.3-management-alpinenoRabbitMQ container image tag. Selects the image tag on container targets. On Amazon MQ the major and minor version it begins with is the broker's RabbitMQ version, one of 4.3, 4.2 (both on the mq.m7g instance types alone) and 3.13; this default begins 4.1, which the service does not run, so the Amazon MQ realizations halt on it, naming the versions to set.
computeobject—no—
storageobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.
control_plane_presentbooleanfalsenoOperator affirmation that the RabbitMQ Cluster Operator (control plane) is installed in the target cluster. A controller-driven realization halts the build unless this is set true, so a RabbitmqCluster custom resource is never emitted as an orphan into a cluster that cannot reconcile it. The synthesized realizations ignore this flag. The Amazon MQ realizations do not read it and halt the build while it is true: no RabbitMQ control plane is installed for Amazon MQ.
credentialsstring (generated | supplied)generatednoWho owns the broker's credentials on a controller-driven realization. `generated` — the controller creates the credential Secret and owns the password, which is what it does when nothing is supplied; the developer's `user` value is still honored, and no password reaches the rendered artifact. `supplied` — the controller reads the credentials from an existing Secret named in `credentials_secret` and generates none. The synthesized realizations ignore this key: they always take the password from the `password` credential slot. The Amazon MQ realizations do not read it either, and halt the build on `supplied`.
credentials_secretstringnoName of the existing Secret a controller-driven realization reads the broker credentials from when `credentials` is `supplied`. The Secret lives in the same namespace as the broker and carries the same entries the controller would otherwise generate — `username`, `password`, `default_user.conf`, `host`, `port`, `provider` and `type`. Leave it empty when `credentials` is `generated`; a controller-driven build halts if `supplied` is selected without it. The Amazon MQ realizations do not read it and halt the build while it is set.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesAddress a producer or consumer opens its broker connection to. Which Service carries it follows the realization the Manifest selected, so a consumer reads this rather than deriving a name. On Amazon MQ it is a pointer string the target resolves to the host of the broker's AMQP endpoint — a Terraform reference, or a CloudFormation intrinsic that a consumer in another stack imports — or the DNS name the Release sets in infra.overrides.host instead, so a consumer on another target receives an address it can resolve. The broker's certificate names its own endpoint, so a client checking it fails against that DNS name.
portinteger—yesTCP port the broker accepts client connections on. It carries the messaging port, never the management API port, so a consumer reaches the broker rather than its dashboard; on Amazon MQ it is 5671.
protocolstring—noWire protocol the published address speaks, which is what a consumer selects a client library and its connection security for — `amqp`, AMQP without TLS, from the self-hosted realizations, and `amqps`, AMQP over TLS, from the Amazon MQ realizations, since the service requires TLS on every client connection.
metrics_endpointstring—noThe full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:15692/metrics`. Empty while values.metrics_enabled is false, and on the controller-driven realization while the cluster runs more than one node, which then publishes `metrics_service` instead.
metrics_servicestring—noName of the Service every node's metrics sit behind, for a scraper that discovers each endpoint of that Service rather than scraping one address. Set by the controller-driven realization while values.metrics_enabled is true and the cluster runs more than one node, beside `metrics_service_port` and `metrics_path`; empty otherwise.
metrics_service_portstring—noName of the port of `metrics_service` that carries the metrics, `prometheus`. Set and empty together with `metrics_service`.
metrics_pathstring—noPath the metrics are served at, `/metrics`, published beside `metrics_service`. Empty where the component publishes `metrics_endpoint`, which carries its own path.

Uses sockets

The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.

No uses sockets declared.

Attachment slots

Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.

SlotSelectorRequiredInjectSensitiveDescription
passwordfeature.aggrega.ai/kind=secretnoenvyesBroker password credential. Attached, it supplies the RabbitMQ application-user password via the credential subsystem. Unattached, compose/rabbitmq and helm/rabbitmq set it to the development literal `devpass`, which this catalog publishes, so every Release built with them that leaves the slot unattached shares that password, and the Amazon MQ Recipes halt the build: they take core/random-password alone, with values.symbols false and values.length 12 or more, as Amazon MQ refuses a password shorter than 12 characters or holding a comma, colon or equals sign.

Self-inject allowlist

env

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

This entity uses nothing in the catalog.

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy