• Document Up to Date

Studio Clustering Enterprise only feature

Crafter Studio can be clustered for high-availability. In the image below, two Crafter Studio instances are clustered as primary and secondary along with a Crafter Studio Arbiter to act as arbitrator.

CrafterCMS - Studio Enterprise Clustering

When setting up a Studio cluster, a specific node needs to be started first as a reference point, then the other nodes (Studio and/or Arbiter) can join and form the cluster. This is known as cluster bootstrapping. Bootstrapping is the first step to introduce a node as Primary Component, which others will see as a reference point to sync up with.

The Primary Component is a central concept on how to ensure that there is no opportunity for database inconsistency or divergence between the nodes in case of a network split. The Primary Component is a set of nodes that communicate with each other over the network and contains the majority of the nodes. There’s no Primary Component yet when starting up a cluster, hence the need of the first node to bootstrap the Component. The other nodes will then look for the existing Primary Component to join.


Studio nodes use an in-memory distributed data store to orchestrate the bootstrapping of the Primary Component, so you don’t need to do it. When the cluster is started, the nodes synchronize through the data store to decide which one does the bootstrapping, and then the rest join the Primary Component.

The cluster must have three nodes at the minimum, so in case there’s only two Studios in the cluster, a Studio Arbiter must be started too. This arbitrator functions as an odd node, to avoid split-brain situations and it can also provide a consistent application state snapshot, which is useful in making backups.

A node in the cluster needs to be set as a primary publisher before any publishing can happen. We recommend setting the primary publishing node from the load balancer, if possible. Note that a node in the cluster will not publish on boot.

To set a node as the primary publishing node, issue the cluster setClusterPrimary API:

It is not recommended to switch the primary publishing node often. Only switch the primary publishing node to a healthy node during a failover.


Before we begin configuring Studio for clustering, the following must be setup:

  • A DNS server directing traffic to the primary node, and can failover to the secondary node if the primary is not healthy

Configuring Studio Clustering

First, we’ll take a look at an example of how to setup a two node cluster with Studio and a Studio Arbiter step by step, then, we’ll take a look at an example of setting up Studio clustering using a Kubernetes deployment