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

Remove the concept of worker "types" #10441

@anoadragon453

Description

@anoadragon453

We're currently midway through the process of fading out the concept of different types for a Synapse worker process. For example synapse.app.pusher, synapse.app.federation_sender etc. While initially this provided a quick way to configure a worker to perform certain actions, it is also rather confusing and the inability to specify multiple types per worker can limit the flexibility of deployment.

For instance, it's currently not possible to configure a worker to both send events to appservices (synapse.app.appservice) and update the user directory tables (synapse.app.user_dir), as the functionality is forcefully disabled unless the worker is specifically marked as each respective type:

if config.worker_app == "synapse.app.appservice":
if config.appservice.notify_appservices:
sys.stderr.write(
"\nThe appservices must be disabled in the main synapse process"
"\nbefore they can be run in a separate worker."
"\nPlease add ``notify_appservices: false`` to the main config"
"\n"
)
sys.exit(1)
# Force the appservice to start since they will be disabled in the main config
config.appservice.notify_appservices = True
else:
# For other worker types we force this to off.
config.appservice.notify_appservices = False
if config.worker_app == "synapse.app.user_dir":
if config.server.update_user_directory:
sys.stderr.write(
"\nThe update_user_directory must be disabled in the main synapse process"
"\nbefore they can be run in a separate worker."
"\nPlease add ``update_user_directory: false`` to the main config"
"\n"
)
sys.exit(1)
# Force the pushers to start since they will be disabled in the main config
config.server.update_user_directory = True
else:
# For other worker types we force this to off.
config.server.update_user_directory = False

Instead, workers should be configured via worker file config options, so that one could simply set notify_appservices: true and update_user_directory: true in the worker config to enable the worker to handle both sets of tasks.

As many worker deployments currently rely on the worker_type configuration, a deprecation period is necessary. A rough plan for carrying this out could look like:

  • Allow all current worker configurations through config file values alone.
  • Announce a deprecation period for the worker_type config option.
  • After some time, remove the worker_type config option. All workers are now a "generic worker", though this term is no longer a necessary distinction.

In the short term, the first step would allow for more immediate flexibility for medium-sized deployments - which need to move tasks off the main process, but don't have the resources to spin up a separate worker for each type.

Superseded worker types so far

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-WorkersProblems related to running Synapse in Worker Mode (or replication)T-EnhancementNew features, changes in functionality, improvements in performance, or user-facing enhancements.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions