synapse icon indicating copy to clipboard operation
synapse copied to clipboard

[Doc] Support K8S install

Open JuanSeBestia opened this issue 4 years ago • 5 comments

Description: The architecture proposes based on workers makes me guess that it can be easily implemented on K8S, but in the documentation to install Synapse, k8s is not there.

I see some resources from k8s and helm charts decimated around GitHub and ArtifactHub respectively.

Are there any popular among us?

Could we consider creating an official helm-package?

JuanSeBestia avatar Feb 11 '21 00:02 JuanSeBestia

We don't have any official k8s/helm packages, though I know people do run Synapse happily in k8s. In general we try and limit the number of packages we maintain officially, as a) they're hard to maintain when you don't use them yourself and b) often they can suddenly turn into quite a time sink if they break.

Having said that, we'd probably be open to adding some docs around best practices for k8s, or pointing at helm packages that are considered good/battle tested/well maintained/etc. Though there is always concern that such information gets quickly out of date if and when Synapse or k8s change.

If someone wants to give that a go then I'd recommend talking to us in #synapse-dev:matrix.org before spending much time on it. Alternatively, if someone has a blog post/guide then we can probably add it to the list at https://matrix.org/docs/guides

erikjohnston avatar Feb 11 '21 10:02 erikjohnston

https://github.com/matrix-org/synapse/issues/9072 is a bit related here, in that we don't even have good docs on how to run workers under docker, which seems to me to be a subset of the work needed here.

richvdh avatar Feb 11 '21 12:02 richvdh

An officially maintained Kubernetes Operator would go a long way to facilitating "enterprise" deployments and ensuring feature parity with Mattermost.

bardiharborow avatar Mar 09 '21 21:03 bardiharborow

Just for reference, this is the synapse chart I'm using. There are 2-3 others on artifacthub but all of them seem outdated at least a bit.

varac avatar Dec 21 '21 20:12 varac

A popular K8s / Helm chart https://gitlab.com/ananace/charts/-/tree/master/charts/matrix-synapse

dklimpel avatar Oct 06 '22 15:10 dklimpel

FYI, I started a Kubernetes Operator for Synapse in Go: https://github.com/opdev/synapse-operator

mgoerens avatar Dec 06 '22 15:12 mgoerens