HarperDB instance clustering and replication can be configured directly through the HarperDB Studio. It is recommended to read through the clustering documentation first to gain a strong understanding of HarperDB clustering behavior.
All clustering configuration is handled through the cluster page of the HarperDB Studio, accessed with the following instructions:
- Navigate to the HarperDB Studio Organizations page.
- Click the appropriate organization that the instance belongs to.
- Select your desired instance.
- Click cluster in the instance control bar.
Note, the cluster page will only be available to super users.
HarperDB instances do not have clustering configured by default. The HarperDB Studio will walk you through the initial configuration. Upon entering the cluster screen for the first time you will need to complete the following configuration. Configurations are set in the enable clustering panel on the left while actions are described in the middle of the screen.
- Create a cluster user, read more about this here: Clustering Users and Roles.
- Enter username.
- Enter password.
- Click Create Cluster User.
- Click Set Cluster Node Name.
- Click Enable Instance Clustering.
At this point the Studio will restart your HarperDB Instance, required for the configuration changes to take effect.
Once initial clustering configuration is completed you a presented with a clustering management screen with the following properties:
- connected instances
Displays all instances within the Studio Organization that this instance manages a connection with.
- unconnected instances
Displays all instances within the Studio Organization that this instance does not manage a connection with.
- unregistered instances
Displays all instances outside of the Studio Organization that this instance manages a connection with.
- manage clustering
Once instances are connected, this will display clustering management options for all connected instances and all schemas and tables.
Connect an Instance
HarperDB Instances can be clustered together with the following instructions.
- Ensure clustering has been configured on both instances and a cluster user with identical credentials exists on both.
- Identify the instance you would like to connect from the unconnected instances panel.
- Click the plus icon () next the appropriate instance.
- If configurations are correct, all schemas will sync across the cluster, then appear in the manage clustering panel. If there is a configuration issue, a red exclamation icon () will appear, click it to learn more about what could be causing the issue.
Disconnect an Instance
HarperDB Instances can be disconnected with the following instructions.
- Identify the instance you would like to disconnect from the connected instances panel.
- Click the minus icon () next the appropriate instance.
Subscriptions must be configured in order to move data between connected instances. Read more about subscriptions here: Creating A Subscription. The manage clustering panel displays a table with each row representing an channel per instance. Cells are bolded to indicate a change in the column. Publish and subscribe replication can be configured per table with the following instructions:
- Identify the instance, schema, and table for replication to be configured.
- For publish, click the toggle switch () in the publish column.
- For subscribe, click the toggle switch () in the subscribe column.