From 4b09b7438e99e379c483026fb578f92fd7e30d9f Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Tue, 3 Nov 2020 10:27:11 +0000
Subject: [PATCH] Document how to set up multiple event persisters (#8706)
---
changelog.d/8706.doc | 1 +
docs/workers.md | 12 ++++++++++++
2 files changed, 13 insertions(+)
create mode 100644 changelog.d/8706.doc
diff --git a/changelog.d/8706.doc b/changelog.d/8706.doc
new file mode 100644
index 0000000000..96a0427e73
--- /dev/null
+++ b/changelog.d/8706.doc
@@ -0,0 +1 @@
+Document experimental support for running multiple event persisters.
diff --git a/docs/workers.md b/docs/workers.md
index cd1f823b77..4e046bdb31 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -319,6 +319,18 @@ stream_writers:
events: event_persister1
```
+The `events` stream also experimentally supports having multiple writers, where
+work is sharded between them by room ID. Note that you *must* restart all worker
+instances when adding or removing event persisters. An example `stream_writers`
+configuration with multiple writers:
+
+```yaml
+stream_writers:
+ events:
+ - event_persister1
+ - event_persister2
+```
+
#### Background tasks
There is also *experimental* support for moving background tasks to a separate
--
GitLab