Installing JIRA Data Center
This illustration shows the general method of installing a JIRA clustered instance:
This install guide assumes that you already have a JIRA instance, already have a load balancer, and are able to set up a network file share system.
Before upgrading from an earlier version of JIRA, back up your data. Refer to Automating JIRA Backups.
1. Upgrade your JIRA instance to 6.3 or later
JIRA clustering is only available from 6.3 onwards and you must purchase a JIRA Data Center license to use the clustering functionality of JIRA Data Center. Please contact our sales team for information about purchasing a JIRA Data Center license.
2. Set up the JIRA file storage location on shared storage
In this step, you need to set up a shared home directory that is writable by the JIRA instance and any future nodes.
There are multiple ways to do this, but the simplest is to use an NFS share. The mechanics of setting one is unique from installation to installation and is outside the scope of this document.
Assuming that the final mount point for this shared storage location is /data/jira/sharedhome :
- Ensure that directory can be read and written by other potential nodes
- Copy the following directories into /data/jira/sharedhome: (some of them may be empty)
3. Configure your existing JIRA instance to work in a cluster
Set up the following on your existing JIRA instance:
- Put a
cluster.propertiesfile in the local JIRA home directory, with contents as follows:
- If using the Apache load balancer, set the Apache node name by appending the following setting to the same variable (replacing
node1with the node name used in the load balancer configuration):
4. Add the first node to your load balancer
JIRA Data Center relies on a load balancer to balance traffic between the nodes. Many larger installations of JIRA already have a reverse proxy configured, and many reverse proxies have the ability to perform load balancing as well. We've provided a sample Apache httpd configuration to serve as an example, but please check with your proxy vendor for specific information.
After adding JIRA to the load balancer, ensure that basic functionality is working after restarting the JIRA instance by navigating to the instance, logging in, and noting any broken links or malfunctioning JIRA functionality.
Be sure to check that the base server URL is configured properly (to the load balancer public URL).
5. Add a new JIRA node to the cluster
- Copy the JIRA installation directory to a new host. Atlassian recommends that your configuration deviates from the first installation as little as possible to ease the burden of documentation and deployment (e.g. Installation paths, users, file permissions, etc).
- Ensure that the new host can access the shared home directory (e.g. ensure that you can read the contents of the shared JIRA directory and have write access to it)
- Copy the local home directory from the first node to this new node.
- Alter the cluster.properties file to reference the new node id. All node ids must be unique among nodes.
- Start the new node and monitor for startup problems.
- Ensure that issue creation, search, attachments, and customizations work as expected.
6. Connect this new node to the load balancer
Verify that the new node is in the cluster and receiving requests by checking the logs on each node to ensure both are receiving traffic and also check that updates done on one node are visible on the other.
Repeat steps 5 and 6 for each node.
Cluster.properties file parameters
You can set the following parameters in the
|Yes||This unique ID must match the username and the |
|Yes||The location of the shared home directory for all JIRA nodes|
Describes how nodes find each other:
|No||The hostname of the current node for cache communication. JIRA Data Center will resolve this this internally if the parameter isn't set. |
If you have problems resolving the hostname of the network you can set this parameter.
The port the node is going to be listening to ( default = 40001)
if multiple nodes are on the same host or this port is not available, you might need to set this manually.
|No||By default this is set to the Ehcache default|
If you set
automatic then you need to set the following parameters:
Refer to the Ehcache documentation for more information on these parameters.