diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2022-09-06 03:50:02 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-06 07:50:02 +0000 |
| commit | 32fc3b7ba4702a0068a82bdd0595e2f426967d4d (patch) | |
| tree | 54285b0ad220062fa07ab72f1b1b2415afc4f94e /docs/upgrade.md | |
| parent | Reduce number of CI jobs run on PRs (#13713) (diff) | |
| download | synapse-32fc3b7ba4702a0068a82bdd0595e2f426967d4d.tar.xz | |
Remove configuration options for direct TCP replication. (#13647)
Removes the ability to configure legacy direct TCP replication. Workers now require Redis to run.
Diffstat (limited to 'docs/upgrade.md')
| -rw-r--r-- | docs/upgrade.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/upgrade.md b/docs/upgrade.md index 422a3da664..c6219d06e8 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -91,6 +91,21 @@ process, for example: # Upgrading to v1.67.0 +## Direct TCP replication is no longer supported: migrate to Redis + +Redis support was added in v1.13.0 with it becoming the recommended method in +v1.18.0. It replaced the old direct TCP connections (which was deprecated as of +v1.18.0) to the main process. With Redis, rather than all the workers connecting +to the main process, all the workers and the main process connect to Redis, +which relays replication commands between processes. This can give a significant +CPU saving on the main process and is a prerequisite for upcoming +performance improvements. + +To migrate to Redis add the [`redis` config](./workers.md#shared-configuration), +and remove the TCP `replication` listener from config of the master and +`worker_replication_port` from worker config. Note that a HTTP listener with a +`replication` resource is still required. + ## Minimum version of Poetry is now v1.2.0 The minimum supported version of poetry is now 1.2. This should only affect |