Browse Source

Add note regarding thread stack size on Windows

This commit adds a note to the Windows service docs regarding the thread
stack size setting for the Windows service installer. As the Apache
Commons procrun daemon requires that this setting be explicitly set, we
need a value to be set when the service is installed. The right place
for this setting is the jvm.options file. We do not want to ship with a
hard-coded value here because we do not want to override the default
setting on other platforms, and the right default depends on whether or
not the end-user is on a 32-bit versus a 64-bit Windows system.

Relates #18324
Jason Tedor 9 years ago
parent
commit
56a07f70f7
1 changed files with 5 additions and 0 deletions
  1. 5 0
      docs/reference/setup/install/windows.asciidoc

+ 5 - 0
docs/reference/setup/install/windows.asciidoc

@@ -106,6 +106,11 @@ Using JAVA_HOME (64-bit):  "c:\jvm\jdk1.8"
 The service 'elasticsearch-service-x64' has been installed.
 --------------------------------------------------
 
+NOTE: The service installer requires that the thread stack size setting
+be configured in jvm.options *before* you install the service. On
+32-bit Windows, you should add `-Xss320k` to the jvm.options file, and
+on 64-bit Windows you should add `-Xss1m` to the jvm.options file.
+
 NOTE: While a JRE can be used for the Elasticsearch service, due to its use of a client VM (as opposed to a server JVM which offers better performance for long-running applications) its usage is discouraged and a warning will be issued.
 
 NOTE: Upgrading (or downgrading) JVM versions does not require the service to be reinstalled. However, upgrading across JVM types (e.g. JRE versus SE) is not supported, and does require the service to be reinstalled.