From 43ef469570faf556250c7b87222ad900992c28f2 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Mon, 1 Jun 2020 09:44:32 -0400 Subject: [PATCH] [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 --- docs/reference/modules.asciidoc | 2 - docs/reference/modules/indices.asciidoc | 50 ------------------- .../modules/indices/circuit_breaker.asciidoc | 2 +- .../modules/indices/fielddata.asciidoc | 2 +- .../modules/indices/indexing_buffer.asciidoc | 2 +- .../modules/indices/query_cache.asciidoc | 2 +- .../modules/indices/recovery.asciidoc | 2 +- .../modules/indices/request_cache.asciidoc | 2 +- .../modules/indices/search-settings.asciidoc | 2 +- docs/reference/redirects.asciidoc | 15 +++++- docs/reference/setup.asciidoc | 24 +++++++-- 11 files changed, 40 insertions(+), 65 deletions(-) delete mode 100644 docs/reference/modules/indices.asciidoc diff --git a/docs/reference/modules.asciidoc b/docs/reference/modules.asciidoc index 0852e259f64..440c02e8e30 100644 --- a/docs/reference/modules.asciidoc +++ b/docs/reference/modules.asciidoc @@ -79,8 +79,6 @@ include::modules/gateway.asciidoc[] include::modules/http.asciidoc[] -include::modules/indices.asciidoc[] - include::modules/network.asciidoc[] include::modules/node.asciidoc[] diff --git a/docs/reference/modules/indices.asciidoc b/docs/reference/modules/indices.asciidoc deleted file mode 100644 index 49c96e7393d..00000000000 --- a/docs/reference/modules/indices.asciidoc +++ /dev/null @@ -1,50 +0,0 @@ -[[modules-indices]] -== Indices - -The indices module controls index-related settings that are globally managed -for all indices, rather than being configurable at a per-index level. - -Available settings include: - -<>:: - - Circuit breakers set limits on memory usage to avoid out of memory exceptions. - -<>:: - - Set limits on the amount of heap used by the in-memory fielddata cache. - -<>:: - - Configure the amount of heap used to cache queries results. - -<>:: - - Control the size of the buffer allocated to the indexing process. - -<>:: - - Control the behaviour of the shard-level request cache. - -<>:: - - Control the resource limits on the shard recovery process. - -<>:: - - Control global search settings. - -include::indices/circuit_breaker.asciidoc[] - -include::indices/fielddata.asciidoc[] - -include::indices/query_cache.asciidoc[] - -include::indices/indexing_buffer.asciidoc[] - -include::indices/request_cache.asciidoc[] - -include::indices/recovery.asciidoc[] - -include::indices/search-settings.asciidoc[] - diff --git a/docs/reference/modules/indices/circuit_breaker.asciidoc b/docs/reference/modules/indices/circuit_breaker.asciidoc index 7969057330d..4b1351abe82 100644 --- a/docs/reference/modules/indices/circuit_breaker.asciidoc +++ b/docs/reference/modules/indices/circuit_breaker.asciidoc @@ -1,5 +1,5 @@ [[circuit-breaker]] -=== Circuit Breaker +=== Circuit breaker settings Elasticsearch contains multiple circuit breakers used to prevent operations from causing an OutOfMemoryError. Each breaker specifies a limit for how much memory diff --git a/docs/reference/modules/indices/fielddata.asciidoc b/docs/reference/modules/indices/fielddata.asciidoc index e8c8a8d2c49..1d5ad568939 100644 --- a/docs/reference/modules/indices/fielddata.asciidoc +++ b/docs/reference/modules/indices/fielddata.asciidoc @@ -1,5 +1,5 @@ [[modules-fielddata]] -=== Fielddata +=== Field data cache settings The field data cache is used mainly when sorting on or computing aggregations on a field. It loads all the field values to memory in order to provide fast diff --git a/docs/reference/modules/indices/indexing_buffer.asciidoc b/docs/reference/modules/indices/indexing_buffer.asciidoc index d3aa436c5d4..9ce14da4f58 100644 --- a/docs/reference/modules/indices/indexing_buffer.asciidoc +++ b/docs/reference/modules/indices/indexing_buffer.asciidoc @@ -1,5 +1,5 @@ [[indexing-buffer]] -=== Indexing Buffer +=== Indexing buffer settings The indexing buffer is used to store newly indexed documents. When it fills up, the documents in the buffer are written to a segment on disk. It is divided diff --git a/docs/reference/modules/indices/query_cache.asciidoc b/docs/reference/modules/indices/query_cache.asciidoc index 9b1736096f6..855a673eaeb 100644 --- a/docs/reference/modules/indices/query_cache.asciidoc +++ b/docs/reference/modules/indices/query_cache.asciidoc @@ -1,5 +1,5 @@ [[query-cache]] -=== Node Query Cache +=== Node query cache settings The results of queries used in the filter context are cached in the node query cache for fast lookup. There is one queries cache per node that is shared by all diff --git a/docs/reference/modules/indices/recovery.asciidoc b/docs/reference/modules/indices/recovery.asciidoc index 26c7d938b12..92e6c730c6d 100644 --- a/docs/reference/modules/indices/recovery.asciidoc +++ b/docs/reference/modules/indices/recovery.asciidoc @@ -1,5 +1,5 @@ [[recovery]] -=== Index recovery +=== Index recovery settings Peer recovery syncs data from a primary shard to a new or existing shard copy. diff --git a/docs/reference/modules/indices/request_cache.asciidoc b/docs/reference/modules/indices/request_cache.asciidoc index 45d46e3a771..e2551e188ee 100644 --- a/docs/reference/modules/indices/request_cache.asciidoc +++ b/docs/reference/modules/indices/request_cache.asciidoc @@ -1,5 +1,5 @@ [[shard-request-cache]] -=== Shard request cache +=== Shard request cache settings When a search request is run against an index or against many indices, each involved shard executes the search locally and returns its local results to diff --git a/docs/reference/modules/indices/search-settings.asciidoc b/docs/reference/modules/indices/search-settings.asciidoc index 61992062b38..7308a5b5097 100644 --- a/docs/reference/modules/indices/search-settings.asciidoc +++ b/docs/reference/modules/indices/search-settings.asciidoc @@ -1,5 +1,5 @@ [[search-settings]] -=== Search Settings +=== Search settings The following expert settings can be set to manage global search and aggregation limits. diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc index c139b130741..10d872bcbd8 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -615,6 +615,19 @@ See <> and <>. See <>, <>, and <>. +[role="exclude",id="modules-indices"] +=== Indices module + +See: + +* <> +* <> +* <> +* <> +* <> +* <> +* <> + [role="exclude",id="cat-transform"] === cat transform API @@ -799,4 +812,4 @@ See <>. We have stopped adding new customers to our {esms}. If you are interested in similar capabilities, contact -https://support.elastic.co[Elastic Support] to discuss available options. \ No newline at end of file +https://support.elastic.co[Elastic Support] to discuss available options. diff --git a/docs/reference/setup.asciidoc b/docs/reference/setup.asciidoc index f3dfb9c6bc1..83996950b37 100644 --- a/docs/reference/setup.asciidoc +++ b/docs/reference/setup.asciidoc @@ -45,22 +45,36 @@ include::setup/jvm-options.asciidoc[] include::setup/secure-settings.asciidoc[] -include::setup/logging-config.asciidoc[] - -include::settings/audit-settings.asciidoc[] - include::settings/ccr-settings.asciidoc[] +include::modules/indices/circuit_breaker.asciidoc[] + +include::modules/indices/recovery.asciidoc[] + +include::modules/indices/indexing_buffer.asciidoc[] + +include::modules/indices/fielddata.asciidoc[] + include::settings/ilm-settings.asciidoc[] include::settings/license-settings.asciidoc[] +include::setup/logging-config.asciidoc[] + include::settings/ml-settings.asciidoc[] include::settings/monitoring-settings.asciidoc[] +include::modules/indices/query_cache.asciidoc[] + +include::modules/indices/request_cache.asciidoc[] + +include::modules/indices/search-settings.asciidoc[] + include::settings/security-settings.asciidoc[] +include::settings/audit-settings.asciidoc[] + include::settings/slm-settings.asciidoc[] include::settings/sql-settings.asciidoc[] @@ -81,4 +95,4 @@ include::setup/stopping.asciidoc[] include::setup/add-nodes.asciidoc[] -include::setup/restart-cluster.asciidoc[] +include::setup/restart-cluster.asciidoc[] \ No newline at end of file