aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-application/src
diff options
context:
space:
mode:
authorSébastien Lesaint <sebastien.lesaint@sonarsource.com>2017-08-18 16:12:42 +0200
committerSimon Brandhof <simon.brandhof@sonarsource.com>2017-09-05 14:24:12 +0200
commit3cd07e43f87d63c80519dae1f77aee84a9c49990 (patch)
tree0d12cacdeccd5774dcc10e7f746f8e92497171d7 /sonar-application/src
parentae5637262461062c7e5fac17c1d6ac5792b5284d (diff)
downloadsonarqube-3cd07e43f87d63c80519dae1f77aee84a9c49990.tar.gz
sonarqube-3cd07e43f87d63c80519dae1f77aee84a9c49990.zip
add warning to sonar.properties about ES Virtual Memory on Linux
Diffstat (limited to 'sonar-application/src')
-rw-r--r--sonar-application/src/main/assembly/conf/sonar.properties11
1 files changed, 11 insertions, 0 deletions
diff --git a/sonar-application/src/main/assembly/conf/sonar.properties b/sonar-application/src/main/assembly/conf/sonar.properties
index 94ba3a3a5ff..fdc340fbb6b 100644
--- a/sonar-application/src/main/assembly/conf/sonar.properties
+++ b/sonar-application/src/main/assembly/conf/sonar.properties
@@ -186,6 +186,17 @@
# ELASTICSEARCH
# Elasticsearch is used to facilitate fast and accurate information retrieval.
# It is executed in a dedicated Java process. Default heap size is 512Mb.
+#
+# --------------------------------------------------
+# Word of caution for Linux users on 64bits systems
+# --------------------------------------------------
+# Please ensure Virtual Memory on your system is correctly configured for Elasticsearch to run properly
+# (see https://www.elastic.co/guide/en/elasticsearch/reference/5.5/vm-max-map-count.html for details).
+#
+# When SonarQube runs standalone, a warning such as the following may appear in logs/es.log:
+# "max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]"
+# When SonarQube runs as a cluster, however, Elasticsearch will refuse to start.
+#
# JVM options of Elasticsearch process
#sonar.search.javaOpts=-Xms512m \