diff options
| -rw-r--r-- | server/sonar-docs/src/pages/setup/install-cluster.md | 22 | ||||
| -rw-r--r-- | server/sonar-docs/src/pages/setup/operate-cluster.md | 8 | ||||
| -rw-r--r-- | server/sonar-docs/src/pages/setup/upgrade-notes.md | 10 |
3 files changed, 28 insertions, 12 deletions
diff --git a/server/sonar-docs/src/pages/setup/install-cluster.md b/server/sonar-docs/src/pages/setup/install-cluster.md index 0a70a2a323e..ffe11ea736a 100644 --- a/server/sonar-docs/src/pages/setup/install-cluster.md +++ b/server/sonar-docs/src/pages/setup/install-cluster.md @@ -90,10 +90,9 @@ The configuration to be added to sonar.properties for each node is the following ``` ... sonar.cluster.enabled=true -sonar.cluster.hosts=ip1,ip2 -sonar.cluster.search.hosts=ip3,ip4,ip5 sonar.cluster.node.type=application -sonar.cluster.node.host=ip1 +sonar.cluster.hosts=ip1,ip2 +sonar.cluster.search.hosts=ip3:9001,ip4:9001,ip5:9001 sonar.auth.jwtBase64Hs256Secret=YOURGENERATEDSECRET ... ``` @@ -102,10 +101,9 @@ sonar.auth.jwtBase64Hs256Secret=YOURGENERATEDSECRET ``` ... sonar.cluster.enabled=true -sonar.cluster.hosts=ip1,ip2 -sonar.cluster.search.hosts=ip3,ip4,ip5 sonar.cluster.node.type=application -sonar.cluster.node.host=ip2 +sonar.cluster.hosts=ip1,ip2 +sonar.cluster.search.hosts=ip3:9001,ip4:9001,ip5:9001 sonar.auth.jwtBase64Hs256Secret=YOURGENERATEDSECRET ... ``` @@ -116,10 +114,12 @@ sonar.auth.jwtBase64Hs256Secret=YOURGENERATEDSECRET ``` ... sonar.cluster.enabled=true -sonar.cluster.search.hosts=ip3,ip4,ip5 sonar.cluster.node.type=search sonar.cluster.node.host=ip3 sonar.search.host=ip3 +sonar.search.port=9001 +sonar.search.transportPort=9002 +sonar.cluster.search.hosts=ip3:9002,ip4:9002,ip5:9002 ... ``` @@ -127,10 +127,12 @@ sonar.search.host=ip3 ``` ... sonar.cluster.enabled=true -sonar.cluster.search.hosts=ip3,ip4,ip5 sonar.cluster.node.type=search sonar.cluster.node.host=ip4 sonar.search.host=ip4 +sonar.search.port=9001 +sonar.search.transportPort=9002 +sonar.cluster.search.hosts=ip3:9002,ip4:9002,ip5:9002 ... ``` @@ -138,10 +140,12 @@ sonar.search.host=ip4 ``` ... sonar.cluster.enabled=true -sonar.cluster.search.hosts=ip3,ip4,ip5 sonar.cluster.node.type=search sonar.cluster.node.host=ip5 sonar.search.host=ip5 +sonar.search.port=9001 +sonar.search.transportPort=9002 +sonar.cluster.search.hosts=ip3:9002,ip4:9002,ip5:9002 ... ``` diff --git a/server/sonar-docs/src/pages/setup/operate-cluster.md b/server/sonar-docs/src/pages/setup/operate-cluster.md index 55a5e1d4639..a69417b968e 100644 --- a/server/sonar-docs/src/pages/setup/operate-cluster.md +++ b/server/sonar-docs/src/pages/setup/operate-cluster.md @@ -101,7 +101,7 @@ Property | Description | Default | Required | ---|---|---|---| `sonar.cluster.enabled`|Set to `true` in each node to activate the cluster mode|`false`|yes `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`|no -`sonar.cluster.search.hosts`|Comma-delimited list of search hosts in the cluster. Each item in the list must contain the port if the default `sonar.search.port` value is not used. Item format is `sonar.search.host` or `sonar.search.host:sonar.search.port`.| |yes +`sonar.cluster.search.hosts`|Comma-delimited list of search hosts in the cluster. Each item in the list must contain the host and port. For search nodes, the item format is `sonar.search.host:sonar.search.transportPort`. For application nodes, the item format is `sonar.search.host:sonar.search.port`.| |yes `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}`|no `sonar.cluster.node.type`|Type of node: either `application` or `search`| |yes `sonar.cluster.node.host`|IP address of the network card that will be used by Hazelcast to communicate with the members of the cluster. Must not be a loopback address.| |yes @@ -110,7 +110,8 @@ Property | Description | Default | Required | ### Application nodes Property | Description | Required ---|---|---|--- -`sonar.cluster.hosts`|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 `sonar.cluster.node.port` value is not used. Item format is `sonar.cluster.node.host` or `sonar.cluster.node.host:sonar.cluster.node.port`.|yes +`sonar.cluster.hosts`|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 `sonar.cluster.node.port` value is not used. Item format is `sonar.cluster.node.host` or `s +onar.cluster.node.host:sonar.cluster.node.port`.|yes `sonar.cluster.node.port`|The Hazelcast port for communication with each application member of the cluster. Default: `9003`|no| `sonar.cluster.node.web.port`|Hazelcast port for communication with the WebServer process. 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.|no `sonar.cluster.node.ce.port`|Hazelcast port for communication with the ComputeEngine process. 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.|no @@ -120,7 +121,8 @@ Property | Description | Required Property | Description | Default | Required ---|---|---|--- `sonar.search.host`|Listening IP. IP must be accessible to all other search and application nodes.|`127.0.0.1`|yes -`sonar.search.port`|Listening port. Port must be accessible to all other search and application nodes.|`9001`|yes +`sonar.search.port`|Listening port. Port must be accessible to all application nodes. This port is used for HTTP communication between search and application nodes|`9001`|yes +`sonar.search.transportPort`|Listening port. Port must be accessible to all other search nodes. This port is used for TCP communication between search nodes.|`9002`|yes `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}{timeunit}`. Valid `{timeunit}` values are: `ms` (milliseconds); `s` (seconds); `m` (minutes); `h` (hours); `d` (days); `w` (weeks)|cluster: 120s; standalone: 30s|no ## Limitations diff --git a/server/sonar-docs/src/pages/setup/upgrade-notes.md b/server/sonar-docs/src/pages/setup/upgrade-notes.md index befdaeadcc3..ebd4a36a9f5 100644 --- a/server/sonar-docs/src/pages/setup/upgrade-notes.md +++ b/server/sonar-docs/src/pages/setup/upgrade-notes.md @@ -2,6 +2,16 @@ title: Release Upgrade Notes url: /setup/upgrade-notes/ --- +## Release 8.6 Upgrade Notes +**Elasticsearch update and change in cluster configuration** +For non-DCE editions, the Elasticsearch upgrade doesn't change the configuration. SonarQube automatically binds to the loopback address an additional Elasticsearch port which can be configured optionally. + +When running a cluster with Data Center Edition, the configuration of search nodes has changed. The old search properties will now fail. You need to configure two new sets of properties. See [Configure and Operate a Cluster](/setup/operate-cluster/) for more information. + +We recommend only giving external access to the application nodes and to the main port. ([SONAR-12686](https://jira.sonarsource.com/browse/SONAR-12686)). + +[Full release notes](https://jira.sonarsource.com/secure/ReleaseNote.jspa?projectId=10930&version=16435) + ## Release 8.5 Upgrade Notes **GitHub Enterprise compatibility** SonarQube 8.5 only supports GitHub Enterprise 2.15+ for pull request decoration (the previous minimum version was 2.14). |