Project

General

Profile

The ungleich Matrix infrastructure » History » Version 13

Timothée Floure, 03/10/2020 09:33 PM

1 1 Timothée Floure
h1. The ungleich Matrix infrastructure
2
3
*%{color:red}This document concerns the infrastructure side of our MaaS offer and is intended for ungleich staff. See [[Ungleich Matrix-as-a-Service (MaaS)]] page for end-user/customer documentation.%*
4
5
h2. Status
6
7 10 Timothée Floure
This document is *A DRAFT*. This service is not in production. Ask @fnux for details.
8 2 Timothée Floure
9 4 Timothée Floure
h2. Environment
10 2 Timothée Floure
11
Our Matrix deployments make use of the "Synapse (reference) Matrix homeserver":https://github.com/matrix-org/synapse/ and "Riot web client":https://about.riot.im/. We use Debian buster as base Operating system, leveraging the "matrix-synapse package from the buster-backports repository":https://packages.debian.org/buster-backports/matrix-synapse. The riot client (= static files) is directly fetched from "upstream releases on github":https://github.com/vector-im/riot-web/releases.
12
13 5 Timothée Floure
The matrix deployments run on ipv6only VMs, HTTP(S) traffic - including federation - being proxy by the [[How to use the IPv4-to-IPv6-Proxy|ungleich v4-to-v6 proxy]]. Federation is delegated using a @/.well-known/@ URI as described in [[Ungleich Matrix-as-a-Service (MaaS)|the customer FAQ]].
14 2 Timothée Floure
15 6 Timothée Floure
!maas.jpg!
16
17 2 Timothée Floure
h2. Tooling
18
19
The whole MaaS setup is defined in the *manifest/matrix-as-a-service* of *dot-cdist* file, which wraps the *__ungleich_matrix* type. This type leverages:
20
21
* *__matrix_synapse*
22
* *__matrix_riot*
23
* *__ungleich_nginx_static_type*
24
* *__postgres_role* and *__postgres_database* from upstream cdist.
25
26 8 Timothée Floure
The "matterbridge":https://github.com/42wim/matterbridge application service can be deployed with the *__matterbridge* type.
27
28 7 Timothée Floure
*Matrix Federation Tester: https://federationtester.matrix.org/*
29
30 12 Timothée Floure
h2. Synapse Admin UI
31
32
* Available on: https://admin.matrix.ungleich.cloud
33
* Leverages https://github.com/Awesome-Technologies/synapse-admin/
34
* Static deployment hence hosted on staticweb.
35
36
* Allows manual admin management of users and rooms.
37 13 Timothée Floure
* Use direct address of homeserver for login: @https://XXXX.matrix.ungleich.cloud@
38 12 Timothée Floure
39 4 Timothée Floure
h2. Monitoring
40 1 Timothée Floure
41 4 Timothée Floure
We plan to leverage consul's service discovery to feed system (node exporter) and matrix (synapse) metrics to prometheus/grafana.
42 2 Timothée Floure
43 4 Timothée Floure
h2. Ungleich Deployments
44 2 Timothée Floure
45 4 Timothée Floure
We maintain our own deployments alongside the customer MaaS, both for our own usage and for testing.
46
47 2 Timothée Floure
h3. matrix-staging.ungleich.ch
48
49 4 Timothée Floure
Staging instance used to tests the deployment pipeline and Matrix updates.
50 2 Timothée Floure
51
h3. matrix.ungleich.ch
52
53 9 Timothée Floure
Production instance for ungleich. Some rooms are bridged to the "chat.ungleich.ch":https://chat.ungleich.ch mattermost instance. The bridge makes use of the @#matterbridge:ungleich.ch@ local matrix user (i.e. not from LDAP) and @matterbridge@ mattermost user (linked to matterbridge AT ungleich ch).
54 11 Timothée Floure
55
h2. Customer Deployments
56
57
That's too sensitive to be public: "this way":https://redmine.ungleich.ch/projects/datacenterlight/wiki/Matrix_customer_deployments !
58 1 Timothée Floure
  
59 10 Timothée Floure
h2. Shared TURN server
60
61
WIP!