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.asciidoc

127 lines
3.1 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[[setup]]
[7.x] [DOCS] Relocate network settings content (#55865) (#57429) * [DOCS] Relocate network settings content (#55865) Moves [network settings content][0] from [Modules][1] to the [Configuring Elasticsearch][2] section. Supporting changes: * Changes page title and headings to sentence case * Increments several headings * Removes several unneeded `[float]` and `[horizontal]` attributes * Removes several unneeded blank links in definition lists [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-network.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html * tweak for consistency
2020-06-01 11:27:27 -04:00
= Set up {es}
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[partintro]
--
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
This section includes information on how to setup Elasticsearch and get it
running, including:
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
* Downloading
* Installing
* Starting
* Configuring
[DOCS] Make apt/yum repos more visible
2014-02-06 11:01:58 -05:00
Update setup.asciidoc Added link to the support matrix to Setup docs
2015-10-09 06:27:05 -04:00
[[supported-platforms]]
[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]
Update setup.asciidoc Added link to the support matrix to Setup docs
2015-10-09 06:27:05 -04:00
== Supported platforms
The matrix of officially supported operating systems and JVMs is available here:
Clarify using supported LTS versions of the Java This commit clarifies that we recommended using supported LTS versions of Java as opposed to supporting a minimum version and any version above that. Relates #27795
2017-12-14 07:47:50 -05:00
link:/support/matrix[Support Matrix]. Elasticsearch is tested on the listed
Update setup.asciidoc Added link to the support matrix to Setup docs
2015-10-09 06:27:05 -04:00
platforms, but it is possible that it will work on other platforms too.
[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: Added recommended Java versions to the docs
2014-09-11 05:13:19 -04:00
[[jvm-version]]
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
== Java (JVM) Version
Docs: Added recommended Java versions to the docs
2014-09-11 05:13:19 -04:00
Add docs for bundled jdk (#40487) This commit changes the note in docs about required java version to note the existence of the bundled jdk and how to bring your own java. It also reorganizes the zip/targz docs as zip is no longer suitable on Linux/MacOS.
2019-03-29 09:04:46 -04:00
Elasticsearch is built using Java, and includes a bundled version of
[DOCS] http -> https, remove outdated plugin docs (#60380) (#60545) Plugin discovery documentation contained information about installing Elasticsearch 2.0 and installing an oracle JDK, both of which is no longer valid. While noticing that the instructions used cleartext HTTP to install packages, this commit replaces HTTPs links instead of HTTP where possible. In addition a few community links have been removed, as they do not seem to exist anymore. Co-authored-by: Alexander Reelsen <alexander@reelsen.net>
2020-07-31 16:16:31 -04:00
https://openjdk.java.net[OpenJDK] from the JDK maintainers (GPLv2+CE)
Clean up docs regarding recommended JVM (#41356) This change clarifies the documentation around the recommended JVM. The recommended JVM is the bundled JVM. If a user does not use our recommended JVM we suggest that they use a supported LTS version of the JVM. Closes #41132
2019-04-18 16:17:16 -04:00
within each distribution. The bundled JVM is the recommended JVM and
is located within the `jdk` directory of the Elasticsearch home directory.
Add docs for bundled jdk (#40487) This commit changes the note in docs about required java version to note the existence of the bundled jdk and how to bring your own java. It also reorganizes the zip/targz docs as zip is no longer suitable on Linux/MacOS.
2019-03-29 09:04:46 -04:00
To use your own version of Java, set the `JAVA_HOME` environment variable.
Clean up docs regarding recommended JVM (#41356) This change clarifies the documentation around the recommended JVM. The recommended JVM is the bundled JVM. If a user does not use our recommended JVM we suggest that they use a supported LTS version of the JVM. Closes #41132
2019-04-18 16:17:16 -04:00
If you must use a version of Java that is different from the bundled JVM,
we recommend using a link:/support/matrix[supported]
[DOCS] http -> https, remove outdated plugin docs (#60380) (#60545) Plugin discovery documentation contained information about installing Elasticsearch 2.0 and installing an oracle JDK, both of which is no longer valid. While noticing that the instructions used cleartext HTTP to install packages, this commit replaces HTTPs links instead of HTTP where possible. In addition a few community links have been removed, as they do not seem to exist anymore. Co-authored-by: Alexander Reelsen <alexander@reelsen.net>
2020-07-31 16:16:31 -04:00
https://www.oracle.com/technetwork/java/eol-135779.html[LTS version of Java].
Clarify using supported LTS versions of the Java This commit clarifies that we recommended using supported LTS versions of Java as opposed to supporting a minimum version and any version above that. Relates #27795
2017-12-14 07:47:50 -05:00
Elasticsearch will refuse to start if a known-bad version of Java is used.
Clean up docs regarding recommended JVM (#41356) This change clarifies the documentation around the recommended JVM. The recommended JVM is the bundled JVM. If a user does not use our recommended JVM we suggest that they use a supported LTS version of the JVM. Closes #41132
2019-04-18 16:17:16 -04:00
The bundled JVM directory may be removed when using your own JVM.
Docs: Added recommended Java versions to the docs
2014-09-11 05:13:19 -04:00
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
--
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
include::setup/install.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
include::setup/configuration.asciidoc[]
add docs on new service.bat facility
2013-09-23 11:24:31 -04:00
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
include::setup/jvm-options.asciidoc[]
Docs: Add setup section for the keystore tool and secure settings (#22838)
2017-01-30 17:56:45 -05:00
include::setup/secure-settings.asciidoc[]
[DOCS] Relocate `shard allocation` module content (#56535) (#57448)
2020-06-01 13:15:08 -04:00
include::settings/audit-settings.asciidoc[]
Reorganised setup docs into better order
2017-07-21 05:24:27 -04:00
[DOCS] Relocate `indices` module content (#54903) (#57413) Moves `indices` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Also removes the [Indices][2] landing page and adds a related redirect. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-indices.html
2020-06-01 09:44:32 -04:00
include::modules/indices/circuit_breaker.asciidoc[]
[DOCS] Removes X-Pack settings section (#39870)
2019-03-14 17:22:06 -04:00
[DOCS] Relocate `shard allocation` module content (#56535) (#57448)
2020-06-01 13:15:08 -04:00
include::modules/cluster.asciidoc[]
[DOCS] Relocate `indices` module content (#54903) (#57413) Moves `indices` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Also removes the [Indices][2] landing page and adds a related redirect. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-indices.html
2020-06-01 09:44:32 -04:00
[DOCS] Relocate `shard allocation` module content (#56535) (#57448)
2020-06-01 13:15:08 -04:00
include::settings/ccr-settings.asciidoc[]
[DOCS] Relocate `indices` module content (#54903) (#57413) Moves `indices` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Also removes the [Indices][2] landing page and adds a related redirect. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-indices.html
2020-06-01 09:44:32 -04:00
[DOCS] Relocate discovery module content (#56611) (#57454) * Moves `Discovery and cluster formation` content from `Modules` to `Set up Elasticsearch`. * Combines `Adding and removing nodes` with `Adding nodes to your cluster`. Adds related redirect. * Removes and redirects the `Modules` page. * Rewrites parts of `Discovery and cluster formation` to remove `module` references and meta references to the section.
2020-06-01 14:13:13 -04:00
include::modules/discovery/discovery-settings.asciidoc[]
[DOCS] Relocate `indices` module content (#54903) (#57413) Moves `indices` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Also removes the [Indices][2] landing page and adds a related redirect. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-indices.html
2020-06-01 09:44:32 -04:00
include::modules/indices/fielddata.asciidoc[]
[DOCS] Removes X-Pack settings section (#39870)
2019-03-14 17:22:06 -04:00
[DOCS] Relocate `HTTP` module content (#56386) (#57439) Moves `HTTP` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Supporting changes: * Replaces `http` with `HTTP` throughout * Replaces `HTTP module` with `HTTP layer` throughout * Increments several headings * Adds explicit anchors to several headings * Removes several unneeded `[float]` attributes Closes #53306 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html
2020-06-01 12:22:55 -04:00
include::modules/http.asciidoc[]
[DOCS] Added settings page for ILM. (#40880) * [DOCS] Added settings page for ILM. * [DOCS] Adding ILM settings file * [DOCS] Moved the ILM settings to a separate section * [DOCS] Linked to the rollover docs. * [DOCS] Tweaked the "required" wording.
2019-04-05 19:38:31 -04:00
include::settings/ilm-settings.asciidoc[]
[7.x] [DOCS] Add supported ESS settings to ES docs (#57953) (#58981) * Adding ESS icons to supported ES settings. * Adding new file for supported ESS settings. * Adding supported ESS settings for HTTP and disk-based shard allocation. * Adding more supported settings for ESS. * Adding descriptions for each Cloud section, plus additional settings. * Adding new warehouse file for Cloud, plus additional settings. * Adding node settings for Cloud. * Adding audit settings for Cloud. * Resolving merge conflict. * Adding SAML settings (part 1). * Adding SAML realm encryption and signing settings. * Adding SAML SSL settings. * Adding Kerberos realm settings. * Adding OpenID Connect Realm settings. * Adding OpenID Connect SSL settings. * Resolving leftover Git merge markers. * Removing Cloud settings page and link to it. * Add link to mapping source * Update docs/reference/docs/reindex.asciidoc * Incorporate edit of HTTP settings * Remove "cloud" from tag and ID * Remove "cloud" from tag and update description * Remove "cloud" from tag and ID * Change "whitelists" to "specifies" * Remove "cloud" from end tag * Removing cloud from IDs and tags. * Changing link reference to fix build issue. * Adding index management page for missing settings. * Removing warehouse file for Cloud and moving settings elsewhere. * Clarifying true/false usage of http.detailed_errors.enabled. * Changing underscore to dash in link to fix ci build.
2020-07-02 19:40:45 -04:00
include::modules/indices/index_management.asciidoc[]
[DOCS] Relocate `shard allocation` module content (#56535) (#57448)
2020-06-01 13:15:08 -04:00
include::modules/indices/recovery.asciidoc[]
include::modules/indices/indexing_buffer.asciidoc[]
[DOCS] Removes X-Pack settings section (#39870)
2019-03-14 17:22:06 -04:00
include::settings/license-settings.asciidoc[]
[DOCS] Relocate `local gateway` setting content (#56448) (#57443) Moves `local gateway` setting content to `Configuring Elasticsearch` from `Modules`. Relates to #53303.
2020-06-01 12:40:15 -04:00
include::modules/gateway.asciidoc[]
[DOCS] Relocate `indices` module content (#54903) (#57413) Moves `indices` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Also removes the [Indices][2] landing page and adds a related redirect. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-indices.html
2020-06-01 09:44:32 -04:00
include::setup/logging-config.asciidoc[]
[DOCS] Removes X-Pack settings section (#39870)
2019-03-14 17:22:06 -04:00
include::settings/ml-settings.asciidoc[]
[DOCS] Moves monitoring settings (#40167)
2019-03-18 14:11:52 -04:00
include::settings/monitoring-settings.asciidoc[]
[DOCS] Relocate `node` module content (#56376) (#57435) Moves `node` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Supporting changes: * Retitles page `Node settings` * Increments several headings * Removes several unneeded `[float]` attributes * Replaces remaining `[float]` attributes with `[discrete]` * Updates the `Other node settings` section Relates to #53307 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html
2020-06-01 12:04:15 -04:00
include::modules/node.asciidoc[]
[7.x] [DOCS] Relocate network settings content (#55865) (#57429) * [DOCS] Relocate network settings content (#55865) Moves [network settings content][0] from [Modules][1] to the [Configuring Elasticsearch][2] section. Supporting changes: * Changes page title and headings to sentence case * Increments several headings * Removes several unneeded `[float]` and `[horizontal]` attributes * Removes several unneeded blank links in definition lists [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-network.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html * tweak for consistency
2020-06-01 11:27:27 -04:00
include::modules/network.asciidoc[]
[DOCS] Relocate `indices` module content (#54903) (#57413) Moves `indices` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Also removes the [Indices][2] landing page and adds a related redirect. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-indices.html
2020-06-01 09:44:32 -04:00
include::modules/indices/query_cache.asciidoc[]
include::modules/indices/search-settings.asciidoc[]
[DOCS] Removes X-Pack settings section (#39870)
2019-03-14 17:22:06 -04:00
include::settings/security-settings.asciidoc[]
[DOCS] Relocate `shard allocation` module content (#56535) (#57448)
2020-06-01 13:15:08 -04:00
include::modules/indices/request_cache.asciidoc[]
[DOCS] Relocate `indices` module content (#54903) (#57413) Moves `indices` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Also removes the [Indices][2] landing page and adds a related redirect. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-indices.html
2020-06-01 09:44:32 -04:00
[DOCS] Align with ILM changes. (#55953) (#56455) * [DOCS] Align with ILM changes. * Apply suggestions from code review Co-authored-by: James Rodewig <james.rodewig@elastic.co> Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com> * Incorporated review comments.
2020-05-08 17:22:27 -04:00
include::settings/slm-settings.asciidoc[]
[DOCS] Adds transform-settings page and its subpage to redirects (#52944) Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2020-03-02 04:48:09 -05:00
include::settings/transform-settings.asciidoc[]
[DOCS] Relocate `transport` module content (#55472) (#57425) Moves `transport` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Supporting changes: * Adds explicit anchors to several headings * Changes several headings to sentence case * Increments several headings * Removes several unneeded `[float]` attributes * Replaces `transport module` with `transport layer` Relates to #53305 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html
2020-06-01 10:56:28 -04:00
include::modules/transport.asciidoc[]
[DOCS] Relocate thread pools content (#55814) (#57432) Moves [thread pools content][0] from [Modules][1] to [Configuring Elasticsearch][2]. Supporting changes: * Changes page title to "Thread pools" * Increments several headings * Removes several unneeded `[float]` attributes * Updates the anchors of several headings Relates to #53307 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-threadpool.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html Co-authored-by: debadair <debadair@elastic.co>
2020-06-01 11:46:16 -04:00
include::modules/threadpool.asciidoc[]
[DOCS] Removes X-Pack settings section (#39870)
2019-03-14 17:22:06 -04:00
include::settings/notification-settings.asciidoc[]
Reorganised setup docs into better order
2017-07-21 05:24:27 -04:00
include::setup/important-settings.asciidoc[]
Add bootstrap check docs This commit adds documentation for the bootstrap checks and provides either links or inline guidance for setting the necessary settings to pass the bootstrap checks. Relates #18605
2016-05-27 06:03:35 -04:00
Docs: Complete rewrite of setup, installation, and configuration docs
2016-04-03 10:09:24 -04:00
include::setup/sysconfig.asciidoc[]
Author: Sean Gallagher Date: Tue Apr 1 12:28:00 2014 Added upgrade.asciidoc and links to it from setup.asciidoc Author: Sean Gallagher Date: Apr 1 2014 Added upgrade.asciidoc Add upgrade instructions Author: Sean Gallagher Date: 4/4/14 Closes issue #5651 Fixed upgrade.asciidoc typo and incorrect usage. Author: Sean Gallagher Date: 4 Apr 2014 Closes 5651
2014-04-01 12:28:08 -04:00
Reorganised setup docs into better order
2017-07-21 05:24:27 -04:00
include::setup/bootstrap-checks.asciidoc[]
[DOCS] Relocate "Remote Clusters" page (#55172) (#57422) Relocates the "Remote Clusters" documentation from the "Modules" section to the "Set up Elasticsearch" section. Supporting changes: * Reorders the "Bootstrap checks for X-Pack" section to immediately follow the "Bootstrap checks"chapter. * Removes an outdated X-Pack `idef` from the "Remote Clusters" intro.
2020-06-01 10:28:34 -04:00
include::setup/bootstrap-checks-xes.asciidoc[]
[DOCS] Starting Elasticsearch (#31701)
2018-07-03 16:40:37 -04:00
include::setup/starting.asciidoc[]
Die with dignity Today when a thread encounters a fatal unrecoverable error that threatens the stability of the JVM, Elasticsearch marches on. This includes out of memory errors, stack overflow errors and other errors that leave the JVM in a questionable state. Instead, the Elasticsearch JVM should die when these errors are encountered. This commit causes this to be the case. Relates #19272
2016-07-07 14:44:03 -04:00
include::setup/stopping.asciidoc[]
[DOCS] Intro for adding nodes (#37202)
2019-01-15 14:11:01 -05:00
[DOCS] Relocate discovery module content (#56611) (#57454) * Moves `Discovery and cluster formation` content from `Modules` to `Set up Elasticsearch`. * Combines `Adding and removing nodes` with `Adding nodes to your cluster`. Adds related redirect. * Removes and redirects the `Modules` page. * Rewrites parts of `Discovery and cluster formation` to remove `module` references and meta references to the section.
2020-06-01 14:13:13 -04:00
include::modules/discovery.asciidoc[]
[DOCS] Intro for adding nodes (#37202)
2019-01-15 14:11:01 -05:00
include::setup/add-nodes.asciidoc[]
[DOCS] Creates a cluster restart documentation page (#48583) Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2019-11-12 08:49:11 -05:00
[DOCS] Relocate "Plugins" page (#54974) (#57418)
2020-06-01 10:07:50 -04:00
include::setup/restart-cluster.asciidoc[]
[DOCS] Relocate "Remote Clusters" page (#55172) (#57422) Relocates the "Remote Clusters" documentation from the "Modules" section to the "Set up Elasticsearch" section. Supporting changes: * Reorders the "Bootstrap checks for X-Pack" section to immediately follow the "Bootstrap checks"chapter. * Removes an outdated X-Pack `idef` from the "Remote Clusters" intro.
2020-06-01 10:28:34 -04:00
include::modules/remote-clusters.asciidoc[]
[DOCS] Relocate "Plugins" page (#54974) (#57418)
2020-06-01 10:07:50 -04:00
include::setup/setup-xes.asciidoc[]
include::setup/setup-xclient.asciidoc[]
include::modules/plugins.asciidoc[]