Set up a Jira Data Center cluster
Jira Data Center allows you to run a cluster of multiple Jira nodes, providing high availability, scalable capacity, and performance at scale. This guides walks you through the process of configuring a Data Center cluster on your own infrastructure.
Not sure if clustering is right for you? Check out Running Jira Data Center in a cluster for a detailed overview.
Before you begin
Things you should know about when setting up your Data Center:
Set up and configure your cluster
1. Install or upgrade your Jira instance
Jira Data Center is available for Jira 7.0, or later. If you're not on this version yet, install or upgrade your Jira instance.
2. Set up the shared directory
You'll need to create a remote directory that is readable and writable by all nodes in the cluster. There are multiple ways to do this, but the simplest is to use an NFS share.
Create a remote directory, accessible by all nodes in the cluster, and name it e.g. sharedhome
Stop your Jira instance.
Copy the following directories from the Jira local home directory to the new
directory (some of them may be empty).data
3. Configure your Jira instance to work in a cluster
In the Jira local home directory, create a
file, with contents as follows:Example cluster.properties file:
# This ID must be unique across the cluster
jira.node.id = node1
# The location of the shared home directory for all Jira nodes
jira.shared.home = /data/jira/sharedhomeFor more information and some additional parameters, see Cluster.properties file parameters.
For Linux installations: We recommend that you increase the maximum number of open files. To do that, add the following line to
:ulimit -n 16384
Start your instance, and apply the Data Center license.
4. Add the first node to the load balancer
The load balancer distributes the traffic between the nodes. If a node stops working, the remaining nodes will take over its workload, and your users won't even notice it.
Add the first node to the load balancer.
Restart the node, and then try opening different pages in Jira. If the load balancer is working properly, you should have no problems with accessing Jira.
5. Add the remaining nodes to the cluster
The approach to adding the remaining nodes to the cluster varies with the method that was used to install Jira on the first node (either manually from a .zip
archive or using a .bin
installer). Follow the steps that correspond to the original installation method.
While adding your nodes to the cluster, you can check their status as follows:
In the upper-right corner of the screen, select Administration > System.
Under System support, select System info. Your nodes will be listed in the Cluster nodes section.
Cluster.properties file parameters
In addition to the required parameters, the cluster.properties file allows you to configure some additional options, mostly related to EhCache.