Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Improve clarity on deprecation of TCP replication
Browse files Browse the repository at this point in the history
Borrows some text from #13647
for the changelog.
  • Loading branch information
Sean Quah committed Aug 31, 2022
1 parent 90c99fb commit d1fb46f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
10 changes: 9 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,15 @@ No significant changes since 1.66.0rc2.

Deployments with multiple workers should note that the direct TCP replication
configuration was deprecated in Synapse v1.18.0 and will be removed in Synapse
v1.67.0. See the [worker documentation](https://matrix-org.github.io/synapse/v1.66/workers.html)
v1.67.0. In particular, the TCP `replication` listener and the

This comment has been minimized.

Copy link
@richvdh

richvdh Aug 31, 2022

Member

link listener to https://matrix-org.github.io/synapse/v1.66/usage/configuration/config_documentation.html#listeners

s/listener/listener type/

also add something like "(not to be confused with the replication resource on the http listener type)" ?

This comment has been minimized.

Copy link
@clokep

clokep Aug 31, 2022

Member

The last sentence tries to clarify that this is not the HTTP listener.

`worker_replication_port` config option are deprecated.

This comment has been minimized.

Copy link
@richvdh

richvdh Aug 31, 2022

Member

s/are deprecated/will be removed/.


To migrate to Redis, add the [`redis` config](https://matrix-org.github.io/synapse/v1.66/workers.html#shared-configuration)
and remove the TCP `replication` listener from config of the master and

This comment has been minimized.

Copy link
@richvdh

richvdh Aug 31, 2022

Member

Too many "and"s. How about "s/and /; then,/" ?

`worker_replication_port` from worker config. Note that a HTTP listener with a
`replication` resource is still required.

See the [worker documentation](https://matrix-org.github.io/synapse/v1.66/workers.html)
for more details.


Expand Down
2 changes: 1 addition & 1 deletion docs/usage/configuration/config_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ Sub-options for each listener include:

* `metrics`: (see the docs [here](../../metrics-howto.md)),

* `replication`: (see the docs [here](../../workers.md)).
* `replication`: (deprecated as of Synapse 1.18, see the docs [here](../../workers.md)).

* `tls`: set to true to enable TLS for this listener. Will use the TLS key/cert specified in tls_private_key_path / tls_certificate_path.

Expand Down

0 comments on commit d1fb46f

Please sign in to comment.