High Availability is a feature of the Data Center Edition.
Once the the SonarQube cluster is installed , you have a High Availability configuration that will allow your SonarQube instance to stay up and running even if there is a crash or failure in one of the nodes of the cluster.
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 all of the nodes of your cluster are operation.
To call it from monitoring system without having to give admin credentials, it is possible to setup a System Passcode through the property sonar.web.systemPasscode. This has to be configured in the sonar.properties.
In the System Info page, you can check whether your cluster is running safely (green) or has some nodes with problems (orange or red).
If you change the number of Compute Engine workers in the UI, you must restart each application node to have it take this change into account.
When the Project Move feature is used in a DC installation:
(follow the default configuration first, details below is only for specific cases)
Hazelcast is used to manage the communication between the nodes of the cluster. You don't need to install it yourself, it's provided out of the box.
The following properties may be defined in the $SONARQUBE_HOME/config/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.
| Property | Description | Default | Mandatory | Value for application nodes | Value for search nodes |
|---|---|---|---|---|---|
sonar.cluster.enabled | Activates the cluster mode | false | mandatory | true | true |
sonar.cluster.name | 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. | sonarqube | optional | (see description) | (see description) |
sonar.cluster.hosts | Comma-delimited list of all hosts in the cluster. Items must contain the port if the default sonar.cluster.node.port value is not used. Items format is sonar.cluster.node.host or sonar.cluster.node.host:sonar.cluster.node.port.
| (none) | mandatory | (see description) | (see description) |
sonar.cluster.search.hosts | Comma-delimited list of search hosts in the cluster. Items must contain the port if the default sonar.search.port value is not used. Items format is sonar.search.host or sonar.search.host:sonar.search.port. | (none) | mandatory | (see description) | (see description) |
sonar.cluster.node.name | The name of the node that is used on Elasticsearch and stored in Hazelcast member attribute (NODE_NAME) for sonar-application | sonarqube-{UUID} | optional | (see description) | (see description) |
sonar.cluster.node.type | Type of node: either application or search | (none) | mandatory | application | search |
sonar.cluster.node.host | IP address of the network card that will be used by Hazelcast to communicate with the members of the cluster. If not specified, the first interface will be chosen (note that loopback interfaces won't be selected) | (none) | optional
| (see description) | (see description) |
sonar.cluster.node.port | The Hazelcast port for communication with each host (member) of the cluster.
| 9003 | optional | (see description) | (see description) From 7.2+: none |
sonar.cluster.node.web.port | Hazelcast port for communication with the ComputeEngine process, only for application nodes. Port must be accessible to all other search and application nodes. If not specified, a dynamic port will be chosen and all ports must be open among the nodes. | (none) | optional | (see description) | (none) |
sonar.cluster.node.ce.port | Hazelcast port for communication with the WebServer process, only for application nodes. Port must be accessible to all other search and application nodes. If not specified, a dynamic port will be chosen and all ports must be open among the nodes. | (none) | optional | (see description) | (none) |
sonar.search.host | Listening IP, only for search nodes. IP must be accessible to all other search and application nodes. | 127.0.0.1 | mandatory for search nodes | (none) | (see description) |
sonar.search.port | Listening port, only for search nodes. Port must be accessible to all other search and application nodes. | 9001 | optional | (none) | (see description) |
sonar.search.initialStateTimeout | 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 : {integer}{time unit}. Valid {timeunit} values are :
| cluster: standalone: | optional | (none) | (see description) |
sonar.auth.jwtBase64Hs256Secret | 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 sonar.properties for details about how to generate this secret key. | (none) | mandatory | (see description) | (none) |