Matrix Stack Chart
This Helm chart deploys a coherent Matrix Stack. It currently includes the following components
- Synapse as a Matrix homeserver
- Element Web as a Matrix client
Common
The components deployed in the chart can share some configuration. You'll find below the relevant base sections of values.yaml that you can configure at the top of the chart.
Labels
The components deployed in the chart can share labels using the labels base section. Configure any value here to set global labels, which will then be applied to each component's labels. You can override them on a per component basis. You can unset a common label on a per-component basis by setting it to null.
labels:
my-deployment: ess-deployment
Ingress Configuration
Ingresses of the individual components in the chart can share the same configuration using the ingress base section.
Configure any annotations, className, tlsSecret here to set them globally, which will then apply them to each component ingresses. You can override them on a per component basis. You can unset a common ingress annotation on a per-component basis by setting it to null.
ingress:
className: nginx
annotations:
kubernetes.io/ingress.class: nginx
cert-manager.io/cluster-issuer: letsencrypt-prod
tlsSecret: my-tls-secret
Tolerations and Topology Spread Constraints configuration
Workloads of the individual components in the chart can share the same configuration using the tolerations and topologySpreadConstraints base section.
- Configure Tolerations here to apply them globally. They are appended to the per component tolerations.
- Configure Topology Spread Constraints here to apply them globally.You can override them on a per component basis. Please note that setting
topologySpreadConstraints- Automatically sets
labelSelector.matchLabelsbased onapp.kubernetes.io/instanceif one isn't specified. - Automatically sets
matchLabelKeysbased onpod-template-hashforDeploymentsif one isn't specified
- Automatically sets
tolerations:
- key: "key"
operator: "Equal"
value: "value"
effect: "NoSchedule"
topologySpreadConstraints:
- topologyKey: "kubernetes.io/hostname"
maxSkew: 2
whenUnsatisfiable: PreferNoSchedule
Synapse
A minimal set of values to bring up Synapse would be
serverName: ess.localhost
synapse:
ingress:
host: synapse.ess.localhost
registrationSharedSecret:
value: A Secret
macaroon:
value: Another Secret
signingKey:
value: ed25519 0 bNQOzBUDszff7Ax81z6w0uZ1IPWoxYaazT7emaZEfpw
postgres:
host: ess-postgres
user: synapse_user
database: synapse
password:
secret: ess-postgres
secretKey: password
The 4 credentials shown can either be provided inline in the values with value or if you
have an existing Secret in the cluster in the same namespace you can use secret and
secretKey to reference it. Signing keys
serverName is the value that is embedded in user IDs, room IDs, etc. It can't be changed
after the initial deployment and so should be chosen carefully. If federating
https://<serverName>/.well-known/matrix/server must be available and contain the
location of this Synapse. Future versions of this chart will do this for you.
Additional Synapse configuration can be provided inline in the values as a string with
synapse:
additional:
## Either reference config to inject by:
1-custom-config:
config: |
admin_contact: "mailto:[email protected]"
## Either reference an existing `Secret` by:
2-custom-config:
configSecret: custom-synapse-config
configSecretKey: shared.yaml
Full details on available configuration options can be found at https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html
Synapse is enabled for deployment by default can be disabled with the following values
synapse:
enabled: false
Other settings for Synapse can be seen under the synapse section of
helm show values for this chart.
Element Web
A minimal set of values to bring up Element Web would be
elementWeb:
ingress:
host: element.ess.localhost
If serverName is set this will be configured in Element Web. If Synapse is enabled
this will be configured in Element Web as well.
Additional Element Web configuration can be provided as arbitrary sub-properties with
elementWeb:
additional:
default_theme: dark
default_server_config:
m.identity_server:
base_url: https://vector.im
Full details on available configuration options can be found at https://github.com/element-hq/element-web/blob/develop/docs/config.md.
Element Web is enabled for deployment by default can be disabled with the following values
elementWeb:
enabled: false
Other settings for Element Web can be seen under the elementWeb section of
helm show values for this chart.
Well Known Delegation
A minimal set of values to bring up Well Known Delegation would be
servername: ess.localhost
If Synapse is enabled, its ingress host will be configured in Well Known Delegation config file as well.
Additional Well Known Delegation configuration can be provided as arbitrary sub-properties with
wellKnownDelegation:
additional:
server: |
{"some": "config"}
client: |
{"some": "config"}
element: |
{"some": "config"}
Well Known Delegation is enabled for deployment by default can be disabled with the following values
wellKnownDelegation:
enabled: false
Other settings for Well Known Delegation can be seen under the wellKnownDelegation section of
helm show values for this chart.