Skip to main content

Configuring Nodes (Legacy)

Note

High Availability Clustering is a legacy feature that only works on the Orient database.

All new deployments should use one of our new high availability or resilient deployment options described in Resiliency and High Availability.

What is a Node?

We refer to each separate instance of NXRM in a high availability cluster as a node. Nodes can run on physical or virtual servers, containers, or cloud services like Amazon Web Services EC2 instances. While multiple nodes can exist on the same physical or virtual server, each bound to different ports for testing purposes, but such a setup is discouraged in production as it does not provide for a redundant clustered environment.

Each node needs its own local storage for the $data-dirfolder. This folder must not be shared by any other node in the cluster. Within the local storage, a node will store:

  • local instance configuration (network ports, nexus.properties, logging)

  • local log files

  • a complete copy of the internally managed OrientDB databases NXRM uses to store configuration and asset metadata

  • a complete copy of the ElasticSearch indexes

In addition, all nodes need shared storage for blob stores.

How many Nodes will you need?

NXRM HA-C is intended for use with 3 nodes. It will not work properly with less than 3.

Any node can accept a write, but for the write to be committed it must be replicated to a 'majority' of available running nodes. OrientDB calculates a majority using the following formula: (number of expected running nodes / 2) + 1

A write (e.g. publishing assets, changing system configuration) will fail if nodes in your cluster unexpectedly lose connectivity or die and fewer than the calculated majority are running. However you can still write to your NXRM HA-C environment with only 1 running node as long as the other members of the cluster have either a) not started yet or b) were shutdown cleanly. The NXRM HA-C feature includes monitoring for this condition and controls to help you get your cluster running again.

Warning

Adding more than 3 nodes will result decreased performance due to the additional overhead incurred by database synchronization between the nodes. We recommend using no more and no less than 3 nodes in an HA cluster.

What data is replicated between Nodes?

NXRM HA-C uses Hazelcast to keep the OrientDB databases completely in sync in an "Active-Active" configuration.

The ElasticSearch indices on the running nodes operate independently and do not share data; they do automatically index all content replicated in OrientDB.

Blobs, the assets (.jar, .xml, .tar.gz, docker images, etc.) in your repositories, are not replicated. They are stored in your blob stores.

Note

Your next step is to plan your blob stores with Configuring Storage before proceeding to Initial Setup - High Availability Clustering (Legacy).