Configure & Operate a Cluster
High availability and cluster scalability are features of the Data Center Edition.
Once the SonarQube cluster is installed, you have a high availability configuration that allows your SonarQube instance to stay up and running even if there is a crash or failure in one of the cluster's nodes. Your SonarQube cluster is also scalable, and you can add application nodes to increase your computing capabilities.
Start, Stop, or Upgrade the Cluster
Start the Cluster
To start a cluster, you need to follow these steps in order:
- Start the search nodes
- Start the application nodes
Stop the Cluster
To stop a cluster, you need to follow these steps in order:
- Stop the application nodes
- Stop the search nodes
- Stop the cluster.
- Upgrade SonarQube on all nodes (application part, plugins, JDBC driver if required) following the usual upgrade procedure but without triggering the /setup phase.
- Once all nodes have the same binaries: restart the cluster.
- At this point, only one of the application nodes is up. Try to access
node_ip:port/setupon each application node, and trigger the setup operation on the one that responds.
Start or Stop a Node
You can start or stop a single node in the same way as starting and stopping an instance using a single server. By default, it's a graceful shutdown where no new analysis report processing can start, but the tasks in progress are allowed to finish.
Install or Upgrade a Plugin
- Stop the application nodes.
Install or upgrade the plugin on the application nodes.
- If upgrading, remove the old version.
- You don't need to install plugins on search nodes.
- Restart the application nodes.
You have the option of adding application nodes (up to 10 total application nodes) to your cluster to increase computing capabilities.
Scaling in a Traditional Environment
Adding an Application Node
To add an Application Node:
Configure your new application node in sonar.properties. The following is an example of the configuration to be added to sonar.properties for a sixth application node (server6, ip6) in a cluster with the default five servers:
... sonar.cluster.enabled=true sonar.cluster.node.type=application sonar.cluster.node.host=ip6 sonar.cluster.node.port=9003 sonar.cluster.hosts=ip1,ip2,ip6 sonar.cluster.search.hosts=ip3:9001,ip4:9001,ip5:9001 sonar.auth.jwtBase64Hs256Secret=YOURGENERATEDSECRET ...
Update the configuration of the preexisting nodes to include your new node.
While you don't need to restart the cluster after adding a node, you should ensure the configuration is up to date on all of your nodes to avoid issues when you eventually do need to restart.
Removing an Application Node
When you remove an application node, make sure to update the configuration of the remaining nodes. Much like adding a node, while you don't need to restart the cluster after removing a node, you should ensure the configuration is up to date on all of your nodes to avoid issues when you eventually do need to restart.
Scaling in a Docker Environment
Adding Application Nodes
If you're using docker-compose, you can scale the application nodes using the following command:
docker-compose up -d --scale sonarqube=3
Removing Application Nodes
You can reduce the number of application nodes with the same command used to add application nodes by lowering the number.
CPU and RAM usage on each node have to be monitored separately with an APM.
In addition, we provide a Web API api/system/health you can use to validate that all of the nodes in your cluster are operational.
- GREEN: SonarQube is fully operational
- YELLOW: SonarQube is usable, but it needs attention in order to be fully operational
- RED: SonarQube is not operational
To call it from a monitoring system without having to give admin credentials, it is possible to setup a system passcode. You can configure this through the
sonar.web.systemPasscode property in $SONARQUBE-HOME/conf/sonar.properties if you're using a traditional environment or through the corresponding environment variable if you're using a Docker environment.
On the System Info page at Administration > System, you can check whether your cluster is running safely (green) or has some nodes with problems (orange or red).
Maximum Pending Time for Tasks
On the global Background Tasks page at Administration > Projects > Background Tasks, you can see the number of pending tasks as well as the maximum pending time for the tasks in the queue. This shows the pending time of the oldest background task waiting to be processed. You can use this to evaluate if it might be worth configuring additional Compute Engine workers (Enterprise Edition) or additional nodes (Data Center Edition) to improve SonarQube performance.
Compute Engine Workers
If you change the number of Compute Engine workers in the UI, you must restart each application node to have the change take effect.
When the Project Move feature is used in a DC installation:
- Projects are exported on only one of the application nodes
- The archive of the exported projects must be copied to all the applications nodes in the target server
There are three TCP networks to configure:
- the network of application nodes that relies on Hazelcast.
- the network used for Elasticsearch internal communication between search nodes (
- the network between application nodes and search nodes (
Hazelcast is used to manage the communication between the cluster's application nodes. You don't need to install it yourself, it's provided out of the box.
Docker Environment Configuration
In a Docker environment, your properties are configured using Environment Variables.
Traditional Environment Configuration
The following properties may be defined in the $SONARQUBE-HOME/conf/sonar.properties file of each node in a cluster. When defining a property that contains a list of hosts (
*.hosts) the port is not required if the default port was not overridden in the configuration.
Ports can be unintentionally exposed. We recommend only giving external access to the application nodes and to main port (
|Set to ||yes|
|The name of the cluster. Required if multiple clusters are present on the same network. For example this prevents mixing Production and Preproduction clusters. This will be the name stored in the Hazelcast cluster and used as the name of the Elasticsearch cluster.||no|
|The name of the node that is used on Elasticsearch and stored in Hazelcast member attribute (NODE_NAME) for sonar-application||no|
|Type of node: either ||yes|
|Comma-delimited list of all application hosts in the cluster. This value must contain only application hosts. Each item in the list must contain the port if the default ||yes|
|IP address of the network card that will be used by Hazelcast to communicate with the members of the cluster.||yes|
|The Hazelcast port for communication with each application member of the cluster. Default: ||no|
|The Hazelcast port for communication with the WebServer process. Port must be accessible to all other application nodes. If not specified, a dynamic port will be chosen and all ports must be open among the nodes.||no|
|The Hazelcast port for communication with the ComputeEngine process. Port must be accessible to all other application nodes. If not specified, a dynamic port will be chosen and all ports must be open among the nodes.||no|
|Comma-delimited list of search hosts in the cluster. The list can contain either the host or the host and port, but not both. The item format is ||yes|
|Required for authentication with multiple web servers. It is used to keep user sessions opened when they are redirected from one web server to another by the load balancer. See $SONARQUBE-HOME/conf/sonar.properties) for details about how to generate this secret key.||yes|
|Elasticsearch host of the current node used for HTTP communication between search and application nodes. IP must be accessible to all application nodes.||yes|
|Elasticsearch port of the current node used for HTTP communication between search and application nodes. Port must be accessible to all application nodes.||yes|
|Comma-delimited list of search hosts in the cluster. The list can contain either the host or the host and port but not both. The item format is ||yes|
|Elasticsearch host of the current node used by Elasticsearch internal communication to form a cluster (TCP transport).||localhost||yes|
|Elasticsearch port of the current node used by Elasticsearch internal communication to form a cluster (TCP transport). Port must be accessible to all other search nodes||9002||yes|
|The timeout for the Elasticsearch nodes to elect a master node. The default value will be fine in most cases, but in a situation where startup is failing because of a timeout, this may need to be adjusted. The value must be set in the format: ||cluster: 120s; standalone: 30s||no|
This configuration is optional. To secure access to your setup, you may want to first limit access to the nodes in your network. Elasticsearch authentication just adds another layer of security.
For Elasticsearch authentication, the following properties need to be configured on specific nodes:
|Password for Elasticsearch built-in user (elastic) which will be used on the client site. If provided, it enables authentication. If this property is set, ||no|
|Password for Elasticsearch built-in user (elastic) which will be set in ES. If provided, it enables authentication, and the instance will require additional properties to be set. If this property is set, ||no|
|File path to a keystore in PKCS#12 format. The user running SonarQube must have READ permission to that file. Required if password provided.||no|
|File path to a truststore in PKCS#12 format. The user running SonarQube must have READ permission to that file. Required if password provided.||no|
|Password to the keystore.||no|
|Password to the truststore.||no|
When you're using Docker image, truststore and keystore should be provided as volumes.
- Cluster downtime is required for SonarQube upgrades or plugin installations.
- All application nodes must be stopped when installing, uninstalling, or upgrading a plugin.
- Plugins are not shared, meaning if you install/uninstall/upgrade a given plugin on one application node, you need to perform the same actions on the other application node.
- There is no way to perform actions on the cluster from a central app - all operations must be done manually on each node of the cluster.
Frequently Asked Questions
Does Elasticsearch discover automatically other ES nodes?
No. Multicast is disabled. All hosts (IP+port) must be listed.
Can different nodes run on the same machine?
Yes, but it's best to have one machine for each node to be resilient to failures. To maintain an even higher level of availability, each of your three search nodes can be located in a separate availability zone within the same region.
Can the members of a cluster be discovered automatically?
No, all nodes must be configured in $SONARQUBE-HOME/conf/sonar.properties