Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Timo Ley
synapse
Commits
58d6c931
Commit
58d6c931
authored
8 years ago
by
Matthew Hodgson
Browse files
Options
Downloads
Patches
Plain Diff
PR feedback
parent
b7ffa0e2
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/workers.rst
+9
-5
9 additions, 5 deletions
docs/workers.rst
with
9 additions
and
5 deletions
docs/workers.rst
+
9
−
5
View file @
58d6c931
...
@@ -20,7 +20,7 @@ To enable workers, you need to add a replication listener to the master synapse,
...
@@ -20,7 +20,7 @@ To enable workers, you need to add a replication listener to the master synapse,
listeners:
listeners:
- port: 9092
- port: 9092
bind_address: ''
bind_address: '
127.0.0.1
'
type: http
type: http
tls: false
tls: false
x_forwarded: false
x_forwarded: false
...
@@ -28,6 +28,10 @@ To enable workers, you need to add a replication listener to the master synapse,
...
@@ -28,6 +28,10 @@ To enable workers, you need to add a replication listener to the master synapse,
- names: [replication]
- names: [replication]
compress: false
compress: false
Under **no circumstances** should this replication API listener be exposed to the
public internet; it currently implements no authentication whatsoever and is
unencrypted HTTP.
You then create a set of configs for the various worker processes. These should be
You then create a set of configs for the various worker processes. These should be
worker configuration files should be stored in a dedicated subdirectory, to allow
worker configuration files should be stored in a dedicated subdirectory, to allow
synctl to manipulate them.
synctl to manipulate them.
...
@@ -65,12 +69,12 @@ For instance::
...
@@ -65,12 +69,12 @@ For instance::
worker_pid_file: /home/matrix/synapse/synchrotron.pid
worker_pid_file: /home/matrix/synapse/synchrotron.pid
worker_log_config: /home/matrix/synapse/config/synchrotron_log_config.yaml
worker_log_config: /home/matrix/synapse/config/synchrotron_log_config.yaml
...is a full configuration for a synchotron worker instance, which will expose a
...is a full configuration for a synch
r
otron worker instance, which will expose a
plain HTTP /sync endpoint on port 8083 separately from the /sync endpoint provided
plain HTTP /sync endpoint on port 8083 separately from the /sync endpoint provided
by the main synapse.
by the main synapse.
Obviously you should configure your loadbalancer to route the /sync endpoint to
Obviously you should configure your loadbalancer to route the /sync endpoint to
the synchotron instance(s) in this instance.
the synch
r
otron instance(s) in this instance.
Finally, to actually run your worker-based synapse, you must pass synctl the -a
Finally, to actually run your worker-based synapse, you must pass synctl the -a
commandline option to tell it to operate on all the worker configurations found
commandline option to tell it to operate on all the worker configurations found
...
@@ -80,12 +84,12 @@ in the given directory, e.g.::
...
@@ -80,12 +84,12 @@ in the given directory, e.g.::
Currently one should always restart all workers when restarting or upgrading
Currently one should always restart all workers when restarting or upgrading
synapse, unless you explicitly know it's safe not to. For instance, restarting
synapse, unless you explicitly know it's safe not to. For instance, restarting
synapse without restarting all the synchotrons may result in broken typing
synapse without restarting all the synch
r
otrons may result in broken typing
notifications.
notifications.
To manipulate a specific worker, you pass the -w option to synctl::
To manipulate a specific worker, you pass the -w option to synctl::
synctl -w $CONFIG/workers/synchotron.yaml restart
synctl -w $CONFIG/workers/synch
r
otron.yaml restart
All of the above is highly experimental and subject to change as Synapse evolves,
All of the above is highly experimental and subject to change as Synapse evolves,
but documenting it here to help folks needing highly scalable Synapses similar
but documenting it here to help folks needing highly scalable Synapses similar
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment