Adds note about duplicating java opts in multiple places (opensearch-…

…project#1720) * Adds note about duplicating java opts in multiple places Signed-off-by: JeffH-AWS <[email protected]> * Fixed verb Signed-off-by: JeffH-AWS <[email protected]> * Using JVM options rather than Java options per developer guidance Signed-off-by: JeffH-AWS <[email protected]> * Added short blurb about WHY you shouldn't do it Signed-off-by: JeffH-AWS <[email protected]> Signed-off-by: JeffH-AWS <[email protected]>
partlov · Oct 27, 2022 · 40860b8 · 40860b8
1 parent 0cb8d7e
commit 40860b8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/_opensearch/install/important-settings.md b/_opensearch/install/important-settings.md
@@ -39,6 +39,9 @@ The [sample docker-compose.yml]({{site.url}}{{site.baseurl}}/opensearch/install/
 
   Allows you to access Performance Analyzer on port 9600.
 
+Do not declare the same JVM options in multiple locations because it can result in unexpected behavior or a failure of the OpenSearch service to start. If you declare JVM options using an environment variable, such as `OPENSEARCH_JAVA_OPTS=-Xms3g -Xmx3g`, then you should comment out any references to that JVM option in `config/jvm.options`. Conversely, if you define JVM options in `config/jvm.options`, then you should not define those JVM options using environment variables.
+{: .note}
+
 ### Network requirements
 
   The following ports need to be open for OpenSearch components.