Documentation for setup clustering

Hi everyone
Is there any documentation about how to setup clustering?

Hi,

not really, because it depends on your environment. Here are some hints:

  1. Squidex uses Orleans from Microsoft for clustering. It is a like a network of mini-services (actors) which communicate with other actors in the network. Therefore your cluster members need to be able to communicate to each other. This is not a problem for most scenarios. It is only tricky in Azure container services: https://dotnet.github.io/orleans/

  2. To enable clustering you have to set the following setting to MongoDB. Orleans uses a storage to communicate the status of cluster members to the cluster. https://github.com/Squidex/squidex/blob/master/backend/src/Squidex/appsettings.json#L386

  3. If you use kubernetes, it is recommended to follow this tutorial: https://dotnet.github.io/orleans/docs/deployment/kubernetes.html?q=kubernetes (or just use the helm chart): https://github.com/Squidex/squidex/tree/master/helm/squidex/templates

  4. It is recommended to configure liveness probes and startup probes for kubernetes, e.g. with https://cloud.squidex.io/healthz

1 Like

I have added a list of health checks to the docs: https://docs.squidex.io/01-getting-started/installation/configuration#health-checks

Thx a lot
We’ll check the links and do some tests

1 Like