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

Improve documentation of workers #2700

Merged
merged 1 commit into from
Nov 21, 2017
Merged

Improve documentation of workers #2700

merged 1 commit into from
Nov 21, 2017

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Nov 21, 2017

Fixes #2554

Copy link
Member

@erikjohnston erikjohnston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

other than comment LGTM

docs/workers.rst Outdated

``synapse.app.federation_reader``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
handles receiving federation traffic (including public_rooms API). In
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not all traffic though

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#NotAllEndpoints

@erikjohnston erikjohnston assigned richvdh and unassigned erikjohnston Nov 21, 2017
The above endpoints should all be routed to the synchrotron worker by the
reverse-proxy configuration.

It is possible to run multiple instances of the synchrotron to scale
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for clarity, the other workers should indicate that they cannot be load balanced. Probably just a paragraph above the workers saying "All workers cannot be load balanced unless otherwise stated".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't actually think that's true: I think that most of them can be load-balanced, though the greatest gains are to be found via the synchrotrons. I've identified the ones that definitely can't be load-balanced in 879adee.

docs/workers.rst Outdated
the ``worker_main_http_uri`` setting in the frontend_proxy worker configuration
file. For example::

worker_main_http_uri: http://127.0.0.1:8080
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:8008 instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ours is on :8080. but fair enough, I guess :8008 is more common.

@richvdh
Copy link
Member Author

richvdh commented Nov 21, 2017

I'll merge this in a bit if nobody spots any more problems

@richvdh richvdh merged commit 148c113 into develop Nov 21, 2017
@richvdh richvdh deleted the rav/worker_docs branch November 29, 2017 16:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants