From 8916a6f74145eaa347ca808f2a5f60628b3e9dec Mon Sep 17 00:00:00 2001 From: tobias-trabelsi-sonarsource <64127335+tobias-trabelsi-sonarsource@users.noreply.github.com> Date: Tue, 23 Jun 2020 08:06:01 +0200 Subject: [PATCH] [DOCS] increased limits as the load on the system increased * [DOCS] increased limits as the load on the system increased * [DOCS] mentioned in release notes as well Co-authored-by: michaelbirnstiehl --- .../src/pages/requirements/requirements.md | 26 +++++++++---------- .../src/pages/setup/upgrade-notes.md | 9 +++++++ 2 files changed, 22 insertions(+), 13 deletions(-) diff --git a/server/sonar-docs/src/pages/requirements/requirements.md b/server/sonar-docs/src/pages/requirements/requirements.md index 02a4ab553a0..98461c885de 100644 --- a/server/sonar-docs/src/pages/requirements/requirements.md +++ b/server/sonar-docs/src/pages/requirements/requirements.md @@ -90,10 +90,10 @@ GitLab.com is also supported. ### Linux If you're running on Linux, you must ensure that: -* `vm.max_map_count` is greater or equals to 262144 -* `fs.file-max` is greater or equals to 65536 -* the user running SonarQube can open at least 65536 file descriptors -* the user running SonarQube can open at least 4096 threads +* `vm.max_map_count` is greater than or equal to 524288 +* `fs.file-max` is greater than or equal to 131072 +* the user running SonarQube can open at least 131072 file descriptors +* the user running SonarQube can open at least 8192 threads You can see the values with the following commands: ``` @@ -105,18 +105,18 @@ ulimit -u You can set them dynamically for the current session by running the following commands as `root`: ``` -sysctl -w vm.max_map_count=262144 -sysctl -w fs.file-max=65536 -ulimit -n 65536 -ulimit -u 4096 +sysctl -w vm.max_map_count=524288 +sysctl -w fs.file-max=131072 +ulimit -n 131072 +ulimit -u 8192 ``` To set these values more permanently, you must update either _/etc/sysctl.d/99-sonarqube.conf_ (or _/etc/sysctl.conf_ as you wish) to reflect these values. -If the user running SonarQube (`sonarqube` in this example) does not have the permission to have at least 65536 open descriptors, you must insert this line in _/etc/security/limits.d/99-sonarqube.conf_ (or _/etc/security/limits.conf_ as you wish): +If the user running SonarQube (`sonarqube` in this example) does not have the permission to have at least 131072 open descriptors, you must insert this line in _/etc/security/limits.d/99-sonarqube.conf_ (or _/etc/security/limits.conf_ as you wish): ``` -sonarqube - nofile 65536 -sonarqube - nproc 4096 +sonarqube - nofile 131072 +sonarqube - nproc 8192 ``` You can get more detail in the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/system-config.html). @@ -125,8 +125,8 @@ If you are using `systemd` to start SonarQube, you must specify those limits ins ``` [Service] ... -LimitNOFILE=65536 -LimitNPROC=4096 +LimitNOFILE=131072 +LimitNPROC=8192 ... ``` diff --git a/server/sonar-docs/src/pages/setup/upgrade-notes.md b/server/sonar-docs/src/pages/setup/upgrade-notes.md index baebc1fcbdd..7b12bb0164f 100644 --- a/server/sonar-docs/src/pages/setup/upgrade-notes.md +++ b/server/sonar-docs/src/pages/setup/upgrade-notes.md @@ -8,6 +8,15 @@ The format of several IDs exposed in web services changed and their use is depre A related change is introduced in a plugin API method. See [SONAR-13420](https://jira.sonarsource.com/browse/SONAR-13420). +**System settings recommendations changed** + +In previous versions, the recommended limits regarding threads, file descriptors, and vm.max_map_count were taken from Elasticsearch dependencies. This release reaches these limits occasionally, so we recommend increasing the following settings of your OS while upgrading: + +* vm.max_map_count is greater than or equal to 524288 +* fs.file-max is greater than or equal to 131072 +* the user running SonarQube can open at least 131072 file descriptors +* the user running SonarQube can open at least 8192 threads + ## Release 8.3 Upgrade Notes **Security Hotspots in the built-in Quality Gate** We've added a new condition to the built-in "Sonar way" Quality Gate to make sure all Security Hotspots on New Code are reviewed. The Quality Gate fails if the percentage of new Hotspots reviewed is less than 100%. ([MMF-1907](https://jira.sonarsource.com/browse/MMF-1907)). -- 2.39.5