synapse/docker/Dockerfile-workers

# Inherit from the official Synapse docker image
FROM matrixdotorg/synapse

# Install deps
RUN apt-get update
RUN apt-get install -y supervisor redis nginx

# Remove the default nginx sites
RUN rm /etc/nginx/sites-enabled/default

# Copy Synapse worker, nginx and supervisord configuration template files
COPY ./docker/conf-workers/* /conf/

# Expose nginx listener port
EXPOSE 8080/tcp

# Volume for user-editable config files, logs etc.
VOLUME ["/data"]

# A script to read environment variables and create the necessary
# files to run the desired worker configuration. Will start supervisord.
COPY ./docker/configure_workers_and_start.py /configure_workers_and_start.py
ENTRYPOINT ["/configure_workers_and_start.py"]

HEALTHCHECK --start-period=5s --interval=15s --timeout=5s \
    CMD /bin/sh /healthcheck.sh
Add a dockerfile for running a set of Synapse worker processes (#9162) This PR adds a Dockerfile and some supporting files to the `docker/` directory. The Dockerfile's intention is to spin up a container with: * A Synapse main process. * Any desired worker processes, defined by a `SYNAPSE_WORKERS` environment variable supplied at runtime. * A redis for worker communication. * A nginx for routing traffic. * A supervisord to start all worker processes and monitor them if any go down. Note that this is not currently intended to be used in production. If you'd like to use Synapse workers with Docker, instead make use of the official image, with one worker per container. The purpose of this dockerfile is currently to allow testing Synapse in worker mode with the [Complement](https://github.com/matrix-org/complement/) test suite. `configure_workers_and_start.py` is where most of the magic happens in this PR. It reads from environment variables (documented in the file) and creates all necessary config files for the processes. It is the entrypoint of the Dockerfile, and thus is run any time the docker container is spun up, recreating all config files in case you want to use a different set of workers. One can specify which workers they'd like to use by setting the `SYNAPSE_WORKERS` environment variable (as a comma-separated list of arbitrary worker names) or by setting it to `*` for all worker processes. We will be using the latter in CI. Huge thanks to @MatMaul for helping get this all working :tada: This PR is paired with its equivalent on the Complement side: https://github.com/matrix-org/complement/pull/62. Note, for the purpose of testing this PR before it's merged: You'll need to (re)build the base Synapse docker image for everything to work (`matrixdotorg/synapse:latest`). Then build the worker-based docker image on top (`matrixdotorg/synapse:workers`). 2021-04-14 14:54:49 +02:00			`# Inherit from the official Synapse docker image`
			`FROM matrixdotorg/synapse`

			`# Install deps`
			`RUN apt-get update`
			`RUN apt-get install -y supervisor redis nginx`

			`# Remove the default nginx sites`
			`RUN rm /etc/nginx/sites-enabled/default`

			`# Copy Synapse worker, nginx and supervisord configuration template files`
			`COPY ./docker/conf-workers/* /conf/`

			`# Expose nginx listener port`
			`EXPOSE 8080/tcp`

			`# Volume for user-editable config files, logs etc.`
			`VOLUME ["/data"]`

			`# A script to read environment variables and create the necessary`
			`# files to run the desired worker configuration. Will start supervisord.`
			`COPY ./docker/configure_workers_and_start.py /configure_workers_and_start.py`
			`ENTRYPOINT ["/configure_workers_and_start.py"]`
Create healthcheck script for synapse-workers container (#11429) The intent is to iterate through all the worker ports and only report healthy when all are healthy, starting with the main process. 2021-11-26 15:05:20 +01:00
			`HEALTHCHECK --start-period=5s --interval=15s --timeout=5s \`
			`CMD /bin/sh /healthcheck.sh`