Fixup worker doc (again) #8000

erikjohnston · 2020-07-30T16:56:22Z

This was actually part of #7969, but got lost in the rebase.

richvdh · 2020-07-30T16:58:43Z

docs/workers.md


-### Shared Configuration


could keep these headers?

I'm not really sure how they interact with the prose though, since we explain the worker config files outside the worker configuration section. Which feels a bit weird to me?

I think it's fine. the top section introduces the structure; the later sections explain the details of what you need to put in each file.

What I would say is that the "Worker configuration" section goes on to talk about starting synapse, which could do with its own ###-level heading.

richvdh · 2020-07-30T17:14:13Z

docs/workers.md

+need its own configuration file and can take all of its configuration from the
+shared configuration file.
+
+Normally, only a couple of changes are needed to make an existing configuration


Suggested change

Normally, only a couple of changes are needed to make an existing configuration

### Shared Configuration

Normally, only a couple of changes are needed to make an existing configuration

richvdh · 2020-07-30T17:17:12Z

docs/workers.md


-### Shared Configuration


I think it's fine. the top section introduces the structure; the later sections explain the details of what you need to put in each file.

What I would say is that the "Worker configuration" section goes on to talk about starting synapse, which could do with its own ###-level heading.

dklimpel · 2020-07-31T12:03:27Z

The example worker file is also not up to date.

synapse/docs/systemd-with-workers/workers/federation_reader.yaml

Lines 1 to 5 in e2a4ba6

    
           worker_app: synapse.app.federation_reader 
        
           worker_replication_host: 127.0.0.1 
        
           worker_replication_port: 9092 
        
           worker_replication_http_port: 9093

Missing: worker_name, old worker_replication_port

Can you also fix it?

dklimpel · 2020-08-01T08:34:07Z

I have some other questions:

Is a migration guide planned?
Is it necessary to migrate from TCP replication to redis at the same time like the worker apps (eg. synchrotron to generic_worker)? Or are these different things and independently?

richvdh

lgtm, modulo @dklimpel 's points

erikjohnston · 2020-08-03T13:17:37Z

I have some other questions:

Is a migration guide planned?

Is it necessary to migrate from TCP replication to redis at the same time like the worker apps (eg. synchrotron to generic_worker)? Or are these different things and independently?

The changing of the worker apps is completely separate from the TCP to Redis change. You can do the following completely independently:

Move to Redis by adding redis config (removing TCP replication config is optional)
Change any no longer docced workers to new name by simply replacing e.g. synapse.app.client_reader with synapse.app.generic_worker in the config (and any systemd worker configs)

dklimpel · 2020-08-03T14:17:31Z

My thought was that this information should be included in the documentation. Or is that not useful?

erikjohnston · 2020-08-04T08:46:17Z

I've added a short note about migration, if someone can take a look

richvdh · 2020-08-06T09:33:19Z

docs/workers.md

@@ -418,6 +418,23 @@ all these to be folded into the `generic_worker` app and to use config to define
 which processes handle the various proccessing such as push notifications.


+## Migration from old config


I'd have split this up and had two separate "migration" sections, but this is fine.

@lugino-emeritus

Synapse 1.19.0rc1 (2020-08-13) ============================== Removal warning --------------- As outlined in the [previous release](https://github.com/matrix-org/synapse/releases/tag/v1.18.0), we are no longer publishing Docker images with the `-py3` tag suffix. On top of that, we have also removed the `latest-py3` tag. Please see [the announcement in the upgrade notes for 1.18.0](https://github.com/matrix-org/synapse/blob/develop/UPGRADE.rst#upgrading-to-v1180). Features -------- - Add option to allow server admins to join rooms which fail complexity checks. Contributed by @lugino-emeritus. ([\#7902](#7902)) - Add an option to purge room or not with delete room admin endpoint (`POST /_synapse/admin/v1/rooms/<room_id>/delete`). Contributed by @dklimpel. ([\#7964](#7964)) - Add rate limiting to users joining rooms. ([\#8008](#8008)) - Add a `/health` endpoint to every configured HTTP listener that can be used as a health check endpoint by load balancers. ([\#8048](#8048)) - Allow login to be blocked based on the values of SAML attributes. ([\#8052](#8052)) - Allow guest access to the `GET /_matrix/client/r0/rooms/{room_id}/members` endpoint, according to MSC2689. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#7314](#7314)) Bugfixes -------- - Fix a bug introduced in Synapse v1.7.2 which caused inaccurate membership counts in the room directory. ([\#7977](#7977)) - Fix a long standing bug: 'Duplicate key value violates unique constraint "event_relations_id"' when message retention is configured. ([\#7978](#7978)) - Fix "no create event in auth events" when trying to reject invitation after inviter leaves. Bug introduced in Synapse v1.10.0. ([\#7980](#7980)) - Fix various comments and minor discrepencies in server notices code. ([\#7996](#7996)) - Fix a long standing bug where HTTP HEAD requests resulted in a 400 error. ([\#7999](#7999)) - Fix a long-standing bug which caused two copies of some log lines to be written when synctl was used along with a MemoryHandler logger. ([\#8011](#8011), [\#8012](#8012)) Updates to the Docker image --------------------------- - We no longer publish Docker images with the `-py3` tag suffix, as [announced in the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/UPGRADE.rst#upgrading-to-v1180). ([\#8056](#8056)) Improved Documentation ---------------------- - Document how to set up a client .well-known file and fix several pieces of outdated documentation. ([\#7899](#7899)) - Improve workers docs. ([\#7990](#7990), [\#8000](#8000)) - Fix typo in `docs/workers.md`. ([\#7992](#7992)) - Add documentation for how to undo a room shutdown. ([\#7998](#7998), [\#8010](#8010)) Internal Changes ---------------- - Reduce the amount of whitespace in JSON stored and sent in responses. Contributed by David Vo. ([\#7372](#7372)) - Switch to the JSON implementation from the standard library and bump the minimum version of the canonicaljson library to 1.2.0. ([\#7936](#7936), [\#7979](#7979)) - Convert various parts of the codebase to async/await. ([\#7947](#7947), [\#7948](#7948), [\#7949](#7949), [\#7951](#7951), [\#7963](#7963), [\#7973](#7973), [\#7975](#7975), [\#7976](#7976), [\#7981](#7981), [\#7987](#7987), [\#7989](#7989), [\#8003](#8003), [\#8014](#8014), [\#8016](#8016), [\#8027](#8027), [\#8031](#8031), [\#8032](#8032), [\#8035](#8035), [\#8042](#8042), [\#8044](#8044), [\#8045](#8045), [\#8061](#8061), [\#8062](#8062), [\#8063](#8063), [\#8066](#8066), [\#8069](#8069), [\#8070](#8070)) - Move some database-related log lines from the default logger to the database/transaction loggers. ([\#7952](#7952)) - Add a script to detect source code files using non-unix line terminators. ([\#7965](#7965), [\#7970](#7970)) - Log the SAML session ID during creation. ([\#7971](#7971)) - Implement new experimental push rules for some users. ([\#7997](#7997)) - Remove redundant and unreliable signature check for v1 Identity Service lookup responses. ([\#8001](#8001)) - Improve the performance of the register endpoint. ([\#8009](#8009)) - Reduce less useful output in the newsfragment CI step. Add a link to the changelog section of the contributing guide on error. ([\#8024](#8024)) - Rename storage layer objects to be more sensible. ([\#8033](#8033)) - Change the default log config to reduce disk I/O and storage for new servers. ([\#8040](#8040)) - Add an assertion on `prev_events` in `create_new_client_event`. ([\#8041](#8041)) - Add a comment to `ServerContextFactory` about the use of `SSLv23_METHOD`. ([\#8043](#8043)) - Log `OPTIONS` requests at `DEBUG` rather than `INFO` level to reduce amount logged at `INFO`. ([\#8049](#8049)) - Reduce amount of outbound request logging at `INFO` level. ([\#8050](#8050)) - It is no longer necessary to explicitly define `filters` in the logging configuration. (Continuing to do so is redundant but harmless.) ([\#8051](#8051)) - Add and improve type hints. ([\#8058](#8058), [\#8064](#8064), [\#8060](#8060), [\#8067](#8067))

* commit '079bc3c8e': Fixup worker doc (again) (#8000)

Fixup worker doc (again)

e59dc9a

erikjohnston requested a review from a team July 30, 2020 16:56

Newsfile

f581366

richvdh reviewed Jul 30, 2020

View reviewed changes

Add back headings

8d33692

erikjohnston requested a review from richvdh July 31, 2020 08:31

richvdh approved these changes Aug 3, 2020

View reviewed changes

Update systemd worker example

5a249e5

Add migration notes

da55885

erikjohnston requested a review from richvdh August 4, 2020 08:45

richvdh reviewed Aug 6, 2020

View reviewed changes

richvdh approved these changes Aug 6, 2020

View reviewed changes

erikjohnston merged commit 079bc3c into develop Aug 6, 2020

erikjohnston deleted the erikj/fix_worker_doc branch August 6, 2020 09:36

babolivier pushed a commit that referenced this pull request Sep 1, 2021

Merge commit '079bc3c8e' into anoa/dinsic_release_1_21_x

0a00347

* commit '079bc3c8e': Fixup worker doc (again) (#8000)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixup worker doc (again) #8000

Fixup worker doc (again) #8000

erikjohnston commented Jul 30, 2020

richvdh Jul 30, 2020

erikjohnston Jul 30, 2020

richvdh Jul 30, 2020

richvdh Jul 30, 2020

richvdh Jul 30, 2020

dklimpel commented Jul 31, 2020 •

edited

Loading

dklimpel commented Aug 1, 2020

richvdh left a comment

erikjohnston commented Aug 3, 2020

dklimpel commented Aug 3, 2020

erikjohnston commented Aug 4, 2020

richvdh Aug 6, 2020

		@@ -418,6 +418,23 @@ all these to be folded into the `generic_worker` app and to use config to define
		which processes handle the various proccessing such as push notifications.


		## Migration from old config

Fixup worker doc (again) #8000

Fixup worker doc (again) #8000

Conversation

erikjohnston commented Jul 30, 2020

richvdh Jul 30, 2020

Choose a reason for hiding this comment

erikjohnston Jul 30, 2020

Choose a reason for hiding this comment

richvdh Jul 30, 2020

Choose a reason for hiding this comment

richvdh Jul 30, 2020

Choose a reason for hiding this comment

richvdh Jul 30, 2020

Choose a reason for hiding this comment

dklimpel commented Jul 31, 2020 • edited Loading

dklimpel commented Aug 1, 2020

richvdh left a comment

Choose a reason for hiding this comment

erikjohnston commented Aug 3, 2020

dklimpel commented Aug 3, 2020

erikjohnston commented Aug 4, 2020

richvdh Aug 6, 2020

Choose a reason for hiding this comment

dklimpel commented Jul 31, 2020 •

edited

Loading