Skip to content

Document RabbitMQ pub/sub externally managed topology and consistent hash exchange - #5297

Merged
alicejgibbons merged 17 commits into
dapr:v1.19from
MyMirelHub:docs/rabbitmq-topology-modes
Oct 15, 2026
Merged

alicejgibbons merged 17 commits into
dapr:v1.19from
MyMirelHub:docs/rabbitmq-topology-modes

Conversation

@MyMirelHub

@MyMirelHub MyMirelHub commented Aug 26, 2026 •

Copy link
Copy Markdown
Contributor

Description

Documents the two RabbitMQ pub/sub features added in dapr/components-contrib#4552, and fixes an existing inaccuracy in the same page.

  • exchangeDeclareMode / queueDeclareMode — new section Use an externally managed topology, for brokers whose exchanges and queues are owned by the RabbitMQ Topology Operator, Terraform, or similar. Covers why the collision happens (PRECONDITION_FAILED), what each mode asserts, that dead-letter objects follow the same rule, and that queue arguments become the external owner's responsibility under queueDeclareMode: passive.
  • x-consistent-hash — new section Use a consistent hash exchange for partitioned ordering. The part worth being explicit about is that routingKey means the partition key when publishing and the queue's integer bucket weight when subscribing.
  • exchangeKind allowed values — the table listed only fanout and topic. direct and headers have long been accepted by the component; this corrects the row and adds x-consistent-hash.

Issue reference

Documents dapr/components-contrib#4553 and dapr/components-contrib#4554.

Checklist

  • Content written in the style of existing documentation
  • Code examples included where relevant
  • Cross-referenced from the metadata table to the new sections

…hash exchange

Adds reference for the new exchangeDeclareMode and queueDeclareMode metadata
fields, and for the x-consistent-hash exchange kind.

Also corrects the exchangeKind allowed values, which listed only fanout and
topic although direct and headers have long been accepted.

Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com>
Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com>
@MyMirelHub
MyMirelHub marked this pull request as ready for review August 26, 2026 05:20
@MyMirelHub
MyMirelHub requested review from a team as code owners August 26, 2026 05:20
The component validates exchangeKind against the same allowlist in both
declare modes, matching the allowedValues in metadata.yaml.

Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com>
Dead lettering follows queueDeclareMode, not exchangeDeclareMode; a consistent
hash subscription takes exactly one bucket weight; passive mode accepts any
broker-supported exchange kind.

Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com>
…logy-modes

Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com>

# Conflicts:
#	daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md
@CasperGN CasperGN assigned CasperGN and unassigned CasperGN Oct 12, 2026

@alicejgibbons alicejgibbons left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

few changes

MyMirelHub and others added 7 commits October 12, 2026 15:06
…ubsub/setup-rabbitmq.md

Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com>
Signed-off-by: Mirel <15373565+MyMirelHub@users.noreply.github.com>
…ubsub/setup-rabbitmq.md

Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com>
Signed-off-by: Mirel <15373565+MyMirelHub@users.noreply.github.com>
…ubsub/setup-rabbitmq.md

Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com>
Signed-off-by: Mirel <15373565+MyMirelHub@users.noreply.github.com>
…ubsub/setup-rabbitmq.md

Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com>
Signed-off-by: Mirel <15373565+MyMirelHub@users.noreply.github.com>
…ubsub/setup-rabbitmq.md

Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com>
Signed-off-by: Mirel <15373565+MyMirelHub@users.noreply.github.com>
…ubsub/setup-rabbitmq.md

Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com>
Signed-off-by: Mirel <15373565+MyMirelHub@users.noreply.github.com>
- Add Python and JavaScript alongside Go for the consistent hash publish
  example, matching the rest of the page.
- Name exchangeDeclareMode and queueDeclareMode where the text said "the two".
- Move the mode bullets above the example, fold the trailing sentence into the
  note, and take the suggested wording on the collision sentence.

Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com>
@CasperGN CasperGN self-assigned this Oct 12, 2026

@CasperGN CasperGN left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Round 2 of 3: follow-up on the changes since 0b17ecd.

Every earlier blocker is resolved and the new changes add none.

Nits, not blocking:

  • F1: Dead-letter paragraph says no external owner can pre-create the DLX/DLQ, then says they are left to the queue owner; reword for clarity (daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md)
  • F2: Awkward wording for the error when a passive exchange or queue is missing (daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md)

Drafted with AI assistance and reviewed by me.

The dead-letter paragraph read as a contradiction: runtime-derived names mean
no external owner can pre-create those objects, yet passive mode leaves them to
the queue owner. Split it by mode instead.

Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com>
@MyMirelHub

Copy link
Copy Markdown
Contributor Author

Both addressed in the latest commit, thanks @CasperGN.

F1: the paragraph was conflating two modes. Runtime-derived names are the reason dead lettering follows queueDeclareMode; what happens then differs by mode — declare creates the objects, passive creates nothing and ignores enableDeadLetter, so dead lettering becomes part of the queue definition under whatever names its owner picks. Now split that way.

F2: reworded to say it fails with an error naming the missing object and the mode that stopped it being created.

@CasperGN CasperGN left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Round 3 of 3: follow-up on the changes since 9e9c350.

Every earlier blocker is resolved and the new changes add none.

Resolved since the last round: 2.

Drafted with AI assistance and reviewed by me.

@alicejgibbons alicejgibbons left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@alicejgibbons
alicejgibbons merged commit 5e8610b into dapr:v1.19 Oct 15, 2026
5 checks passed
@nelson-parente nelson-parente added this to the v1.19 milestone Oct 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants