OpenSearch/docs/reference/modules
Jason Tedor b9df2e2287 Improve the out-of-the-box experience
Elasticsearch can be run in a few different ways:
 - from the command line on Linux and Windows
 - as a service on Linux and Windows

on both 32-bit client and 64-bit server VMs. We strive for a great
out-of-the-box experience any of these combinations but today it is
lacking on 32-bit client JVMs and on the Windows service. There are two
deficiencies that arise:
 - on any 32-bit client JVM we fail to start out of the box because we
   force the server JVM in jvm.options
 - when installing the Windows service, the thread stack size must be
   specified in jvm.options

This commit attempts to address these deficiencies.

We should continue to force the server JVM because there are systems
where the server JVM is not active by default (e.g., the 32-bit JDK on
Windows). This does mean that if a user tries to run with a client JVM
they will see a failure message at startup but this is the best that we
can do if we want to continue to force the server JVM. Thus, this commit
at least documents this situation.

To improve the situation with installing the Windows service, this
commit adds a default setting for the thread stack size. This default is
chosen based on the default thread stack size across all 64-bit server
JVMs. This means that if a user tries to run with a 32-bit JVM they
could otherwise see significantly higher memory usage (this situation is
complicated, it's really only on Windows where the extra memory usage is
egregious, but cutting into the 32-bit address space on any system is
bad). So this commit makes it so that the out-of-the-box experience is
improved for the Windows service on 64-bit server JVMs and we document
the need to adjust this setting on 32-bit JVMs.

Again, we are focusing on the out-of-the-box experience here and this
means optimizing for the best experience on any 64-bit server JVM as
this covers the vast majority of the user base. The users that are on
32-bit JVMs will suffer a little bit but at least now any user on any
64-bit server JVM can start Elasticsearch out of the box.

Finally, we fix some references to the jvm.options documentation.

Relates #21920
2016-12-01 17:26:29 -05:00
..
cluster [DOCS] fixes word usage in allocation awareness docs 2016-11-25 11:47:40 -05:00
discovery Fix markup in Zen discovery docs 2016-11-23 10:02:13 -05:00
indices Convert more docs to CONSOLE 2016-09-21 09:36:21 -04:00
scripting Improve the out-of-the-box experience 2016-12-01 17:26:29 -05:00
cluster.asciidoc Fix typo in cluster module docs 2016-07-12 16:32:23 -04:00
discovery.asciidoc [DOCS] add azure and gce discovery plugins 2014-02-06 09:18:42 +01:00
gateway.asciidoc Update gateway.asciidoc (#19572) 2016-07-28 13:09:05 +02:00
http.asciidoc Clarifies the documentation for the `http.cors.enabled` setting (#19890) 2016-08-09 12:54:38 -05:00
indices.asciidoc Fix doc build. 2016-06-22 09:34:49 +02:00
memcached.asciidoc Fix organization rename in all files in project 2016-03-03 12:04:13 -07:00
network.asciidoc Update network.asciidoc 2016-07-08 17:13:10 +02:00
node.asciidoc Fix typos (#21456) 2016-11-10 11:55:04 +01:00
plugins.asciidoc Docs: Prepare plugin and integration docs for 2.0 2015-08-15 18:02:43 +02:00
scripting.asciidoc Remove groovy scripting language (#21607) 2016-11-22 19:24:12 -08:00
snapshots.asciidoc Docs: note about snapshot version compatibility (#20896) 2016-10-13 10:49:32 -04:00
threadpool.asciidoc Add doc note regarding processors bound 2016-10-14 10:32:31 -04:00
thrift.asciidoc Fix organization rename in all files in project 2016-03-03 12:04:13 -07:00
transport.asciidoc Remove LocalTransport in favor of MockTcpTransport (#20695) 2016-10-07 11:27:47 +02:00
tribe.asciidoc Remove custom plugins path 2016-05-26 10:16:25 -04:00