Docker Compose Worker Documentation and Examples #12737

Thumbscrew · 2022-05-14T17:27:09Z

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file. The entry should:
- Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
- Use markdown where necessary, mostly for code blocks.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
Pull request includes a sign off
Code style is correct
(run the linters)

add example generic worker config

fix wording

dklimpel · 2022-05-15T10:06:26Z

Does it make sense to add a link to this documentation in the official docs, e.g. there:

synapse/docs/setup/installation.md

Line 26 in cde8af9

#### Docker images and Ansible playbooks

richvdh

This looks great, thank you! A couple of suggestions below.

Please could you sign off your contribution following the instructions at https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#sign-off. You just need to add a comment to the PR with "Signed-off-by: Your Name your@email.example.org".

changelog.d/12737.doc

contrib/docker_compose_workers/README.md

richvdh · 2022-05-24T10:49:53Z

Does it make sense to add a link to this documentation in the official docs, e.g. there:

yes, I think that makes sense, but it might be easier once this PR has landed, so we can get the link right.

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

Thumbscrew · 2022-05-24T12:26:03Z

This looks great, thank you! A couple of suggestions below.

Please could you sign off your contribution following the instructions at https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#sign-off. You just need to add a comment to the PR with "Signed-off-by: Your Name your@email.example.org".

No problem! I'd rather not put my full name on the PR but I'll follow the private sign off instructions.

Thumbscrew · 2022-06-02T14:04:45Z

Hi, I sent my sign off via email but haven't heard anything back. Please can you confirm if you received it?

Thanks

DMRobertson · 2022-06-07T16:17:54Z

Hi, I sent my sign off via email but haven't heard anything back. Please can you confirm if you received it?

Thanks

Thanks, that's been received. @richvdh was there anything else outstanding you wanted to see here?

richvdh

lgtm. I'm going to assume the sytest failures are unrelated.

richvdh · 2022-06-08T09:26:01Z

thank you!

@Thumbscrew

Synapse 1.62.0 (2022-07-05) =========================== No significant changes since 1.62.0rc3. Authors of spam-checker plugins should consult the [upgrade notes](https://github.com/matrix-org/synapse/blob/release-v1.62/docs/upgrade.md#upgrading-to-v1620) to learn about the enriched signatures for spam checker callbacks, which are supported with this release of Synapse. Synapse 1.62.0rc3 (2022-07-04) ============================== Bugfixes -------- - Update the version of the [ldap3 plugin](https://github.com/matrix-org/matrix-synapse-ldap3/) included in the `matrixdotorg/synapse` DockerHub images and the Debian packages hosted on `packages.matrix.org` to 0.2.1. This fixes [a bug](matrix-org/matrix-synapse-ldap3#163) with usernames containing uppercase characters. ([\matrix-org#13156](matrix-org#13156)) - Fix a bug introduced in Synapse 1.62.0rc1 affecting unread counts for users on small servers. ([\matrix-org#13168](matrix-org#13168)) Synapse 1.62.0rc2 (2022-07-01) ============================== Bugfixes -------- - Fix unread counts for users on large servers. Introduced in v1.62.0rc1. ([\matrix-org#13140](matrix-org#13140)) - Fix DB performance when deleting old push notifications. Introduced in v1.62.0rc1. ([\matrix-org#13141](matrix-org#13141)) Synapse 1.62.0rc1 (2022-06-28) ============================== Features -------- - Port the spam-checker API callbacks to a new, richer API. This is part of an ongoing change to let spam-checker modules inform users of the reason their event or operation is rejected. ([\matrix-org#12857](matrix-org#12857), [\matrix-org#13047](matrix-org#13047)) - Allow server admins to customise the response of the `/.well-known/matrix/client` endpoint. ([\matrix-org#13035](matrix-org#13035)) - Add metrics measuring the CPU and DB time spent in state resolution. ([\matrix-org#13036](matrix-org#13036)) - Speed up fetching of device list changes in `/sync` and `/keys/changes`. ([\matrix-org#13045](matrix-org#13045), [\matrix-org#13098](matrix-org#13098)) - Improve URL previews for sites which only provide Twitter Card metadata, e.g. LWN.net. ([\matrix-org#13056](matrix-org#13056)) Bugfixes -------- - Update [MSC3786](matrix-org/matrix-spec-proposals#3786) implementation to check `state_key`. ([\matrix-org#12939](matrix-org#12939)) - Fix a bug introduced in Synapse 1.58 where Synapse would not report full version information when installed from a git checkout. This is a best-effort affair and not guaranteed to be stable. ([\matrix-org#12973](matrix-org#12973)) - Fix a bug introduced in Synapse 1.60 where Synapse would fail to start if the `sqlite3` module was not available. ([\matrix-org#12979](matrix-org#12979)) - Fix a bug where non-standard information was required when requesting the `/hierarchy` API over federation. Introduced in Synapse v1.41.0. ([\matrix-org#12991](matrix-org#12991)) - Fix a long-standing bug which meant that rate limiting was not restrictive enough in some cases. ([\matrix-org#13018](matrix-org#13018)) - Fix a bug introduced in Synapse 1.58 where profile requests for a malformed user ID would ccause an internal error. Synapse now returns 400 Bad Request in this situation. ([\matrix-org#13041](matrix-org#13041)) - Fix some inconsistencies in the event authentication code. ([\matrix-org#13087](matrix-org#13087), [\matrix-org#13088](matrix-org#13088)) - Fix a long-standing bug where room directory requests would cause an internal server error if given a malformed room alias. ([\matrix-org#13106](matrix-org#13106)) Improved Documentation ---------------------- - Add documentation for how to configure Synapse with Workers using Docker Compose. Includes example worker config and docker-compose.yaml. Contributed by @Thumbscrew. ([\matrix-org#12737](matrix-org#12737)) - Ensure the [Poetry cheat sheet](https://matrix-org.github.io/synapse/develop/development/dependencies.html) is available in the online documentation. ([\matrix-org#13022](matrix-org#13022)) - Mention removed community/group worker endpoints in upgrade.md. Contributed by @olmari. ([\matrix-org#13023](matrix-org#13023)) - Add instructions for running Complement with `gotestfmt`-formatted output locally. ([\matrix-org#13073](matrix-org#13073)) - Update OpenTracing docs to reference the configuration manual rather than the configuration file. ([\matrix-org#13076](matrix-org#13076)) - Update information on downstream Debian packages. ([\matrix-org#13095](matrix-org#13095)) - Remove documentation for the Delete Group Admin API which no longer exists. ([\matrix-org#13112](matrix-org#13112)) Deprecations and Removals ------------------------- - Remove the unspecced `DELETE /directory/list/room/{roomId}` endpoint, which hid rooms from the [public room directory](https://spec.matrix.org/v1.3/client-server-api/#listing-rooms). Instead, `PUT` to the same URL with a visibility of `"private"`. ([\matrix-org#13123](matrix-org#13123)) Internal Changes ---------------- - Add tests for cancellation of `GET /rooms/$room_id/members` and `GET /rooms/$room_id/state` requests. ([\matrix-org#12674](matrix-org#12674)) - Report login failures due to unknown third party identifiers in the same way as failures due to invalid passwords. This prevents an attacker from using the error response to determine if the identifier exists. Contributed by Daniel Aloni. ([\matrix-org#12738](matrix-org#12738)) - Merge the Complement testing Docker images into a single, multi-purpose image. ([\matrix-org#12881](matrix-org#12881), [\matrix-org#13075](matrix-org#13075)) - Simplify the database schema for `event_edges`. ([\matrix-org#12893](matrix-org#12893)) - Clean up the test code for client disconnection. ([\matrix-org#12929](matrix-org#12929)) - Remove code generating comments in configuration. ([\matrix-org#12941](matrix-org#12941)) - Add `Cross-Origin-Resource-Policy: cross-origin` header to content repository's thumbnail and download endpoints. ([\matrix-org#12944](matrix-org#12944)) - Replace noop background updates with `DELETE` delta. ([\matrix-org#12954](matrix-org#12954), [\matrix-org#13050](matrix-org#13050)) - Use lower isolation level when inserting read receipts to avoid serialization errors. Contributed by Nick @ Beeper. ([\matrix-org#12957](matrix-org#12957)) - Reduce the amount of state we pull from the DB. ([\matrix-org#12963](matrix-org#12963)) - Enable testing against PostgreSQL databases in Complement CI. ([\matrix-org#12965](matrix-org#12965), [\matrix-org#13034](matrix-org#13034)) - Fix an inaccurate comment. ([\matrix-org#12969](matrix-org#12969)) - Remove the `delete_device` method and always call `delete_devices`. ([\matrix-org#12970](matrix-org#12970)) - Use a GitHub form for issues rather than a hard-to-read, easy-to-ignore template. ([\matrix-org#12982](matrix-org#12982)) - Move [MSC3715](matrix-org/matrix-spec-proposals#3715) behind an experimental config flag. ([\matrix-org#12984](matrix-org#12984)) - Add type hints to tests. ([\matrix-org#12985](matrix-org#12985), [\matrix-org#13099](matrix-org#13099)) - Refactor macaroon tokens generation and move the unsubscribe link in notification emails to `/_synapse/client/unsubscribe`. ([\matrix-org#12986](matrix-org#12986)) - Fix documentation for running complement tests. ([\matrix-org#12990](matrix-org#12990)) - Faster joins: add issue links to the TODO comments in the code. ([\matrix-org#13004](matrix-org#13004)) - Reduce DB usage of `/sync` when a large number of unread messages have recently been sent in a room. ([\matrix-org#13005](matrix-org#13005), [\matrix-org#13096](matrix-org#13096), [\matrix-org#13118](matrix-org#13118)) - Replaced usage of PyJWT with methods from Authlib in `org.matrix.login.jwt`. Contributed by Hannes Lerchl. ([\matrix-org#13011](matrix-org#13011)) - Modernize the `contrib/graph/` scripts. ([\matrix-org#13013](matrix-org#13013)) - Remove redundant `room_version` parameters from event auth functions. ([\matrix-org#13017](matrix-org#13017)) - Decouple `synapse.api.auth_blocking.AuthBlocking` from `synapse.api.auth.Auth`. ([\matrix-org#13021](matrix-org#13021)) - Add type annotations to `synapse.storage.databases.main.devices`. ([\matrix-org#13025](matrix-org#13025)) - Set default `sync_response_cache_duration` to two minutes. ([\matrix-org#13042](matrix-org#13042)) - Rename CI test runs. ([\matrix-org#13046](matrix-org#13046)) - Increase timeout of complement CI test runs. ([\matrix-org#13048](matrix-org#13048)) - Refactor entry points so that they all have a `main` function. ([\matrix-org#13052](matrix-org#13052)) - Refactor the Dockerfile-workers configuration script to use Jinja2 templates in Synapse workers' Supervisord blocks. ([\matrix-org#13054](matrix-org#13054)) - Add headers to individual options in config documentation to allow for linking. ([\matrix-org#13055](matrix-org#13055)) - Make Complement CI logs easier to read. ([\matrix-org#13057](matrix-org#13057), [\matrix-org#13058](matrix-org#13058), [\matrix-org#13069](matrix-org#13069)) - Don't instantiate modules with keyword arguments. ([\matrix-org#13060](matrix-org#13060)) - Fix type checking errors against Twisted trunk. ([\matrix-org#13061](matrix-org#13061)) - Allow MSC3030 `timestamp_to_event` calls from anyone on world-readable rooms. ([\matrix-org#13062](matrix-org#13062)) - Add a CI job to check that schema deltas are in the correct folder. ([\matrix-org#13063](matrix-org#13063)) - Avoid rechecking event auth rules which are independent of room state. ([\matrix-org#13065](matrix-org#13065)) - Reduce the duplication of code that invokes the rate limiter. ([\matrix-org#13070](matrix-org#13070)) - Add a Subject Alternative Name to the certificate generated for Complement tests. ([\matrix-org#13071](matrix-org#13071)) - Add more tests for room upgrades. ([\matrix-org#13074](matrix-org#13074)) - Pin dependencies maintained by matrix.org to [semantic version](https://semver.org/) bounds. ([\matrix-org#13082](matrix-org#13082)) - Correctly report prometheus DB stats for `get_earliest_token_for_stats`. ([\matrix-org#13085](matrix-org#13085)) - Fix a long-standing bug where a finished logging context would be re-started when Synapse failed to persist an event from federation. ([\matrix-org#13089](matrix-org#13089)) - Simplify the alias deletion logic as an application service. ([\matrix-org#13093](matrix-org#13093)) - Add type annotations to `tests.test_server`. ([\matrix-org#13124](matrix-org#13124))

dklimpel · 2022-09-30T10:57:23Z

Sorry, it is a little bit late, but why have the federation sender a replication listener? IMO it is only needed for generic worker, when it is also a stream writer.

DMRobertson · 2022-09-30T12:34:54Z

We send out cache invalidation messages over replication. This allows worker A to change something in the database and tell worker B that a change has occured. Without this, worker B holds stale data in cache, which is often the cause of a gnarly bug.

dklimpel · 2022-09-30T13:11:07Z

Interesting neither worker doc nor

synapse/docker/configure_workers_and_start.py

Lines 91 to 96 in 65e6755

    
           "federation_sender": { 
        
               "app": "synapse.app.federation_sender", 
        
               "listener_resources": [], 
        
               "endpoint_patterns": [], 
        
               "shared_extra_conf": {"send_federation": False}, 
        
               "worker_extra_conf": "",

mention a replication listener for federation sender, in addition to http and redis replication.

DMRobertson · 2022-09-30T13:28:17Z

Hmm. Maybe I'm getting confused about the different kinds of replication we have again.

Thumbscrew added 5 commits May 14, 2022 17:14

add docker compose workers README

4e2f582

add example generic worker config

add replication listener to generic worker

e88c1e6

add federation sender example

f756fed

move everything to contrib

064bb62

add example docker-compose.yaml

6b726c6

fix wording

Thumbscrew changed the title ~~Docker compose workers~~ docs: docker compose workers May 14, 2022

add changelog file

d1ac8c7

Thumbscrew changed the title ~~docs: docker compose workers~~ Docker Compose Worker Documentation and Examples May 14, 2022

Thumbscrew mentioned this pull request May 14, 2022

Expand and improve workers documentation and example configuration #9072

Open

2 tasks

Thumbscrew marked this pull request as ready for review May 14, 2022 17:34

Thumbscrew requested a review from a team as a code owner May 14, 2022 17:34

erikjohnston added X-Needs-Discussion and removed X-Needs-Discussion labels May 18, 2022

richvdh reviewed May 24, 2022

View reviewed changes

changelog.d/12737.doc Outdated Show resolved Hide resolved

contrib/docker_compose_workers/README.md Outdated Show resolved Hide resolved

Thumbscrew and others added 2 commits May 24, 2022 13:21

fix wording in README

95aac25

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

Update changelog.d/12737.doc

00f585f

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

DMRobertson requested review from richvdh and a team June 7, 2022 16:17

richvdh approved these changes Jun 8, 2022

View reviewed changes

richvdh merged commit c316fe8 into matrix-org:develop Jun 8, 2022

Thumbscrew deleted the docker-compose-workers branch June 8, 2022 09:33

This was referenced Oct 6, 2022

Add sample worker files for pusher and federation_sender #14077

Merged

Remove not needed replication listener in docker compose example #14107

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docker Compose Worker Documentation and Examples #12737

Docker Compose Worker Documentation and Examples #12737

Thumbscrew commented May 14, 2022 •

edited

Loading

dklimpel commented May 15, 2022

richvdh left a comment

richvdh commented May 24, 2022

Thumbscrew commented May 24, 2022

Thumbscrew commented Jun 2, 2022

DMRobertson commented Jun 7, 2022

richvdh left a comment

richvdh commented Jun 8, 2022

dklimpel commented Sep 30, 2022

DMRobertson commented Sep 30, 2022

dklimpel commented Sep 30, 2022

DMRobertson commented Sep 30, 2022

Docker Compose Worker Documentation and Examples #12737

Docker Compose Worker Documentation and Examples #12737

Conversation

Thumbscrew commented May 14, 2022 • edited Loading

Pull Request Checklist

dklimpel commented May 15, 2022

richvdh left a comment

Choose a reason for hiding this comment

richvdh commented May 24, 2022

Thumbscrew commented May 24, 2022

Thumbscrew commented Jun 2, 2022

DMRobertson commented Jun 7, 2022

richvdh left a comment

Choose a reason for hiding this comment

richvdh commented Jun 8, 2022

dklimpel commented Sep 30, 2022

DMRobertson commented Sep 30, 2022

dklimpel commented Sep 30, 2022

DMRobertson commented Sep 30, 2022

Thumbscrew commented May 14, 2022 •

edited

Loading