finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
41a52945d6
matrix-docker-ansible-deploy/roles/custom/matrix-synapse/templates/goofys/systemd/matrix-goofys.service.j2

40 lines
1.9 KiB
Plaintext
Raw Normal View History

Fix indentation in templates Use Jinja2 lstrip_blocks option in templates to ensure consistent indentation in generated files.
2019-05-07 19:23:35 +00:00
#jinja2: lstrip_blocks: "True"
Switch from s3fs to Goofys Improves performance of media store operations.
2018-02-20 19:36:08 +00:00
[Unit]
Description=Matrix Goofys media store
After=docker.service
Requires=docker.service
Fix systemd services autostart problem with Docker 20.10 The Docker 19.04 -> 20.10 upgrade contains the following change in `/usr/lib/systemd/system/docker.service`: ``` -BindsTo=containerd.service -After=network-online.target firewalld.service containerd.service +After=network-online.target firewalld.service containerd.service multi-user.target -Requires=docker.socket +Requires=docker.socket containerd.service Wants=network-online.target ``` The `multi-user.target` requirement in `After` seems to be in conflict with our `WantedBy=multi-user.target` and `After=docker.service` / `Requires=docker.service` definitions, causing the following error on startup for all of our systemd services: > Job matrix-synapse.service/start deleted to break ordering cycle starting with multi-user.target/start A workaround which appears to work is to add `DefaultDependencies=no` to all of our services.
2020-12-10 09:36:39 +00:00
DefaultDependencies=no
Switch from s3fs to Goofys Improves performance of media store operations.
2018-02-20 19:36:08 +00:00
[Service]
Type=simple
matrix_systemd_unit_home_path -> devture_systemd_docker_base_systemd_unit_home_path (via com.devture.ansible.role.systemd_docker_base)
2022-11-04 14:37:47 +00:00
Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}"
Stop containers gracefully, instead of outright killing them
2023-12-06 09:52:23 +00:00
ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} %n
matrix_host_command_docker -> devture_systemd_docker_base_host_command_docker (via com.devture.ansible.role.systemd_docker_base)
2022-11-04 14:39:35 +00:00
ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} rm %n
Use SyslogIdentifier to improve logging Reasoning is the same as for matrix-org/synapse#5023. For us, the journal used to contain `docker` for all services, which is not very helpful when looking at them all together (`journalctl -f`).
2019-05-16 00:41:45 +00:00
matrix_host_command_docker -> devture_systemd_docker_base_host_command_docker (via com.devture.ansible.role.systemd_docker_base)
2022-11-04 14:39:35 +00:00
ExecStart={{ devture_systemd_docker_base_host_command_docker }} run --rm --name %n \
Disable Docker container logging `--log-driver=none` is used for all Docker containers now. All these containers are started through systemd anyway and get logged in journald, so there's no need for Docker to be logging the same thing using the default `json-file` driver. Doing that was growing `/var/lib/docker/containers/..` infinitely until service/container restart. As a result of this, things like `docker logs matrix-synapse` won't work anymore. `journalctl -u matrix-synapse` is how one can see the logs.
2018-09-26 06:11:19 +00:00
--log-driver=none \
Add matrix_synapse_uid, matrix_synapse_gid and matrix_synapse_username
2023-02-17 15:16:50 +00:00
--user={{ matrix_synapse_uid }}:{{ matrix_synapse_gid }} \
Replace some -v instances with --mount `-v` magically creates the source destination as a directory, if it doesn't exist already. We'd like to avoid this magic and the potential breakage that it might cause. We'd rather fail while Docker tries to find things to `--mount` than have it automatically create directories and fail anyway, while having contaminated the filesystem. There's a lot more `-v` instances remaining to be fixed later on. This is just some start. Things like `matrix_synapse_container_additional_volumes` and `matrix_nginx_proxy_container_additional_volumes` were not changed to use `--mount`, as options for each one are passed differently (`ro` is `ro`, but `rw` doesn't exist and `slave` is `bind-propagation=slave`). To avoid breaking people's custom volume mounts, we keep it as it is for now. A deficiency with `--mount` is that it lacks the `z` option (SELinux ownership changes), and some of our `-v` instances use that. I'm not sure how supported SELinux is for us right now, but it might be, and breaking that would not be a good idea.
2020-11-24 08:15:12 +00:00
--mount type=bind,src=/etc/passwd,dst=/etc/passwd,ro \
--mount type=bind,src=/etc/group,dst=/etc/group,ro \
Make S3-mounting path configurable This will make data migration easier.
2021-02-09 20:04:35 +00:00
--mount type=bind,src={{ matrix_s3_media_store_path }},dst=/s3,bind-propagation=shared \
Use new security-opt syntax (: -> =) Related to https://docs.docker.com/engine/deprecated/#separator--of---security-opt-flag-on-docker-run
2023-02-03 18:36:19 +00:00
--security-opt apparmor=unconfined \
Disable Docker container logging `--log-driver=none` is used for all Docker containers now. All these containers are started through systemd anyway and get logged in journald, so there's no need for Docker to be logging the same thing using the default `json-file` driver. Doing that was growing `/var/lib/docker/containers/..` infinitely until service/container restart. As a result of this, things like `docker logs matrix-synapse` won't work anymore. `journalctl -u matrix-synapse` is how one can see the logs.
2018-09-26 06:11:19 +00:00
--cap-add mknod \
--cap-add sys_admin \
--device=/dev/fuse \
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable.
2019-01-12 15:53:00 +00:00
--env-file={{ matrix_synapse_config_dir_path }}/env-goofys \
Disable Docker container logging `--log-driver=none` is used for all Docker containers now. All these containers are started through systemd anyway and get logged in journald, so there's no need for Docker to be logging the same thing using the default `json-file` driver. Doing that was growing `/var/lib/docker/containers/..` infinitely until service/container restart. As a result of this, things like `docker logs matrix-synapse` won't work anymore. `journalctl -u matrix-synapse` is how one can see the logs.
2018-09-26 06:11:19 +00:00
--entrypoint /bin/sh \
Rename playbook variables so they are consistently prefixed Pretty much all variables live in their own `matrix_<whatever>` prefix now and are grouped closer together in the default variables file (`roles/matrix-server/defaults/main.yml`).
2018-11-01 06:46:47 +00:00
{{ matrix_s3_goofys_docker_image }} \
Fix unknown tag error when generating Goofys service `{% matrix_s3_media_store_custom_endpoint_enabled %}` should have been `{% if matrix_s3_media_store_custom_endpoint_enabled %}` instead. Related to #132 (Github Pull Request).
2019-04-10 05:45:02 +00:00
-c 'goofys -f{% if not matrix_s3_media_store_custom_endpoint_enabled %} --storage-class=STANDARD_IA{% endif %}{% if matrix_s3_media_store_custom_endpoint_enabled %} --endpoint={{ matrix_s3_media_store_custom_endpoint }}{% endif %} --region {{ matrix_s3_media_store_region }} --stat-cache-ttl 60m0s --type-cache-ttl 60m0s --dir-mode 0700 --file-mode 0700 {{ matrix_s3_media_store_bucket_name }} /s3'
Use SyslogIdentifier to improve logging Reasoning is the same as for matrix-org/synapse#5023. For us, the journal used to contain `docker` for all services, which is not very helpful when looking at them all together (`journalctl -f`).
2019-05-16 00:41:45 +00:00
Switch from s3fs to Goofys Improves performance of media store operations.
2018-02-20 19:36:08 +00:00
TimeoutStartSec=5min
matrix_host_command_docker -> devture_systemd_docker_base_host_command_docker (via com.devture.ansible.role.systemd_docker_base)
2022-11-04 14:39:35 +00:00
ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} stop %n
Stop containers gracefully, instead of outright killing them
2023-12-06 09:52:23 +00:00
ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} %n
matrix_host_command_docker -> devture_systemd_docker_base_host_command_docker (via com.devture.ansible.role.systemd_docker_base)
2022-11-04 14:39:35 +00:00
ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} rm %n
Replace ExecStopPost with ExecStop Reverts b1b4ba501fdfaa, 90c9801c560b6, a3c84f78ca9c65a, .. I haven't really traced it (yet), but on some servers, I'm observing `ansible-playbook ... --tags=start` completing very slowly, waiting to stop services. I can't reproduce this on all Matrix servers I manage. I suspect that either the systemd version is to blame or that some specific service is not responding well to some `docker kill/rm` command. `ExecStop` seems to work great in all cases and it's what we've been using for a very long time, so I'm reverting to that.
2022-02-05 09:47:39 +00:00
ExecStop=-{{ matrix_host_command_fusermount }} -u {{ matrix_s3_media_store_path }}
Switch from s3fs to Goofys Improves performance of media store operations.
2018-02-20 19:36:08 +00:00
Restart=always
RestartSec=5
Use SyslogIdentifier to improve logging Reasoning is the same as for matrix-org/synapse#5023. For us, the journal used to contain `docker` for all services, which is not very helpful when looking at them all together (`journalctl -f`).
2019-05-16 00:41:45 +00:00
SyslogIdentifier=matrix-goofys
Switch from s3fs to Goofys Improves performance of media store operations.
2018-02-20 19:36:08 +00:00
[Install]
WantedBy=multi-user.target
Reference in New Issue Copy Permalink