Project

General

Profile

The ungleich Matrix infrastructure » History » Revision 15

Revision 14 (Timothée Floure, 03/20/2020 02:22 PM) → Revision 15/22 (Timothée Floure, 06/24/2020 10:27 AM)

h1. The ungleich Matrix infrastructure 

 *%{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. Common operations can be found on: [[https://redmine.ungleich.ch/projects/open-infrastructure/wiki/Common_operations_on_X-as-a-Service]].%* 

 h2. Status 

 This document is *A DRAFT*. This service is not in production. Ask @fnux for details. 

 h2. Environment 

 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. 

 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]]. 

 !maas.jpg! 

 h2. Tooling 

 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: 

 * *__matrix_synapse* 
 * *__matrix_riot* 
 * *__ungleich_nginx_static_type* 
 * *__postgres_role* and *__postgres_database* from upstream cdist. 

 The "matterbridge":https://github.com/42wim/matterbridge application service can be deployed with the *__matterbridge* type. 

 *Matrix Federation Tester: https://federationtester.matrix.org/* 

 h2. Synapse Admin UI 

 * Available on: https://admin.matrix.ungleich.cloud 
 * Leverages https://github.com/Awesome-Technologies/synapse-admin/ 
 * Static deployment hence hosted on staticweb. 

 * Allows manual admin management of users and rooms. 
 * Use direct address of homeserver for login: @https://XXXX.matrix.ungleich.cloud@ 

 h2. Monitoring 

 Autodiscovered from consul in monitoring LAN. We plan to leverage consul's service discovery to feed system (node exporter) and matrix (synapse) metrics to prometheus/grafana. 

 For now we use manually-configured service monitoring: https://redmine.ungleich.ch/projects/open-infrastructure/wiki/The_ungleich_monitoring_infrastructure#ServiceCustomer-monitoring 

 h2. Ungleich Deployments 

 We maintain our own deployments alongside the customer MaaS, both for our own usage and for testing. 

 h3. matrix-staging.ungleich.ch 

 Staging instance used to tests the deployment pipeline and Matrix updates. 

 h3. matrix.ungleich.ch 

 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). 

 h2. Customer Deployments 

 That's too sensitive to be public: "this way":https://redmine.ungleich.ch/projects/datacenterlight/wiki/Matrix_customer_deployments ! 
  
 h2. Shared TURN server 

 Coturn is running at matrix-turn.ungleich.ch. See @matrix-as-a-service@ manifest in dot-cdist for details.