honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/setup/sysconfig.asciidoc

49 lines
1.7 KiB
Plaintext
Raw Normal View History

Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
[[system-config]]
== Important System Configuration
Ideally, Elasticsearch should run alone on a server and use all of the
resources available to it. In order to do so, you need to configure your
operating system to allow the user running Elasticsearch to access more
resources than allowed by default.
Reorganize configuring Elasticsearch docs This commit reorganizes some of the content in the configuring Elasticsearch section of the docs. The changes are: - move JVM options out of system configuration into configuring Elasticsearch - move JVM options to its own page of the docs - move configuring the heap to important Elasticsearch settings - move configuring the heap to its own page of the docs - move all important settings to individual pages in the docs - remove bootstrap.memory_lock from important settings, this is covered in the swap section of system configuration Relates #27755
2017-12-12 10:24:37 -05:00
The following settings *must* be considered before going to production:
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
* <<setup-configuration-memory,Disable swapping>>
* <<file-descriptors,Increase file descriptors>>
* <<vm-max-map-count,Ensure sufficient virtual memory>>
* <<max-number-of-threads,Ensure sufficient threads>>
Reorganize configuring Elasticsearch docs This commit reorganizes some of the content in the configuring Elasticsearch section of the docs. The changes are: - move JVM options out of system configuration into configuring Elasticsearch - move JVM options to its own page of the docs - move configuring the heap to important Elasticsearch settings - move configuring the heap to its own page of the docs - move all important settings to individual pages in the docs - remove bootstrap.memory_lock from important settings, this is covered in the swap section of system configuration Relates #27755
2017-12-12 10:24:37 -05:00
* <<networkaddress-cache-ttl,JVM DNS cache settings>>
Add docs on JNA temp directory not being noexec (#35355) If the underlying mount point for the JNA temporary directory is mounted noexec on Linux, then the JVM will not be able to map the native code in as executable. This will prevent JNA from executing and will prevent Elasticsearch from being able to execute some functions that rely on native code (e.g., memory locking, and installing system call filters). We do not want to get into the business of catching exceptions and parsing messages towards this because these exception messages can change on us. We also do not want to jump through a lot of hoops to check the underlying mount point for noexec. Instead, we will rely on documentation to address this problem. This commit adds to the important system configuration section of the docs that the JNA temporary directory is not on a mount point with the noexec mount option.
2018-11-07 22:25:37 -05:00
* <<executable-jna-tmpdir,Temporary directory not mounted with `noexec`>>
Suggest reducing tcp_retries2 (#59222) Adds documentation suggesting reducing `tcp_retries2` on Linux to detect network partitions more quickly. Relates #34405
2020-07-27 06:39:44 -04:00
* <<system-config-tcpretries,TCP retransmission timeout>>
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
[[dev-vs-prod]]
[DOCS] Swap `[float]` for `[discrete]` (#60134) Changes instances of `[float]` in our docs for `[discrete]`. Asciidoctor prefers the `[discrete]` tag for floating headings: https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/#blocks
2020-07-23 12:42:33 -04:00
[discrete]
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
=== Development mode vs production mode
By default, Elasticsearch assumes that you are working in development mode.
If any of the above settings are not configured correctly, a warning will be
written to the log file, but you will be able to start and run your
Elasticsearch node.
As soon as you configure a network setting like `network.host`, Elasticsearch
assumes that you are moving to production and will upgrade the above warnings
to exceptions. These exceptions will prevent your Elasticsearch node from
starting. This is an important safety measure to ensure that you will not
lose data because of a malconfigured server.
include::sysconfig/configuring.asciidoc[]
include::sysconfig/swap.asciidoc[]
include::sysconfig/file-descriptors.asciidoc[]
include::sysconfig/virtual-memory.asciidoc[]
include::sysconfig/threads.asciidoc[]
Move DNS cache docs to system configuration docs When these docs were moved they should have been moved to the system configuration docs. This commit does that, and also fixes a missing heading that broke the docs build.
2017-11-29 19:57:26 -05:00
include::sysconfig/dns-cache.asciidoc[]
Add docs on JNA temp directory not being noexec (#35355) If the underlying mount point for the JNA temporary directory is mounted noexec on Linux, then the JVM will not be able to map the native code in as executable. This will prevent JNA from executing and will prevent Elasticsearch from being able to execute some functions that rely on native code (e.g., memory locking, and installing system call filters). We do not want to get into the business of catching exceptions and parsing messages towards this because these exception messages can change on us. We also do not want to jump through a lot of hoops to check the underlying mount point for noexec. Instead, we will rely on documentation to address this problem. This commit adds to the important system configuration section of the docs that the JNA temporary directory is not on a mount point with the noexec mount option.
2018-11-07 22:25:37 -05:00
include::sysconfig/executable-jna-tmpdir.asciidoc[]
Suggest reducing tcp_retries2 (#59222) Adds documentation suggesting reducing `tcp_retries2` on Linux to detect network partitions more quickly. Relates #34405
2020-07-27 06:39:44 -04:00
include::sysconfig/tcpretries.asciidoc[]