OpenSearch/docs/reference
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
..
aggregations typo fix (and -> any) (#21860) 2016-11-30 12:56:00 +01:00
analysis Synonym Graph Support (LUCENE-6664) (#21517) 2016-11-28 09:25:49 -08:00
cat Remove lang-python and lang-javascript (#20734) 2016-11-21 22:13:25 -05:00
cluster Fixed bad asciidoc ID in node stats 2016-11-15 17:39:15 +00:00
docs Fixing cut-in-middle paragraph (#21850) 2016-11-29 14:00:26 +01:00
how-to Add a recommendation against large documents to the docs. (#21652) 2016-11-21 15:01:36 +01:00
images Docs: clarify calculation of sigma and lambda in function_score (#20267) 2016-09-02 14:41:07 +02:00
index-modules Update store.asciidoc (#21353) 2016-11-05 14:58:16 +01:00
indices Document that the PUT mapping API with the _default_ type overwrites instead of merging 2016-11-26 12:43:56 +01:00
ingest Merge branch 'master' into feature/seq_no 2016-11-16 09:10:35 -05:00
mapping Add RangeFieldMapper for numeric and date range types 2016-11-29 10:10:14 -06:00
migration Remove indices query (#21837) 2016-11-30 19:37:01 +01:00
modules Improve the out-of-the-box experience 2016-12-01 17:26:29 -05:00
query-dsl Remove indices query (#21837) 2016-11-30 19:37:01 +01:00
search Upgrade to lucene-6.4.0-snapshot-ec38570 (#21853) 2016-11-29 18:40:31 +01:00
setup Improve the out-of-the-box experience 2016-12-01 17:26:29 -05:00
testing Update docs after test-framework moved 2016-11-02 09:51:55 -04:00
aggregations.asciidoc CONSOLEify some aggs docs 2016-10-03 09:22:56 -04:00
analysis.asciidoc First pass at improving analyzer docs (#18269) 2016-05-11 14:17:56 +02:00
api-conventions.asciidoc Document `error_trace` 2016-11-22 19:16:07 -05:00
cat.asciidoc Allows multiple patterns to be specified for index templates (#21009) 2016-11-10 18:00:30 -05:00
cluster.asciidoc Convert more docs to CONSOLE 2016-09-21 09:36:21 -04:00
docs.asciidoc Add support for waiting until a refresh occurs 2016-06-06 11:37:53 -04:00
getting-started.asciidoc Remove groovy scripting language (#21607) 2016-11-22 19:24:12 -08:00
glossary.asciidoc Improve glossary to not refer to types as "like a table" (#17704) 2016-04-13 14:29:47 +02:00
how-to.asciidoc Add support for `quote_field_suffix` to `simple_query_string`. (#21060) 2016-10-28 09:11:57 +02:00
index-modules.asciidoc Add a hard limit for `index.number_of_shard` (#20682) 2016-09-29 11:03:30 +02:00
index.asciidoc [docs] Document Docker installation method 2016-11-17 15:06:32 +02:00
indices.asciidoc Removed the upgrade API docs 2016-10-11 12:21:46 +02:00
ingest.asciidoc Renamed all AUTOSENSE snippets to CONSOLE (#18210) 2016-05-09 15:42:23 +02:00
mapping.asciidoc Reorganised docs for mapping safeguard settings 2016-09-22 14:58:17 +02:00
modules.asciidoc Remove lang-python and lang-javascript (#20734) 2016-11-21 22:13:25 -05:00
query-dsl.asciidoc Fixed broken xrefs to query-dsl-not-query, which has been removed. 2015-10-20 13:01:37 -07:00
redirects.asciidoc Remove indices query (#21837) 2016-11-30 19:37:01 +01:00
release-notes.asciidoc Remove links to release notes 2016-09-08 18:07:39 +02:00
search.asciidoc Makes search action cancelable by task management API 2016-10-25 12:27:34 -10:00
setup.asciidoc Improve the out-of-the-box experience 2016-12-01 17:26:29 -05:00
testing.asciidoc [DOCS] Test framework documentation 2013-12-02 18:01:45 +01:00