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
This commit is contained in:
parent
25f69547d9
commit
43ef469570
|
@ -79,8 +79,6 @@ include::modules/gateway.asciidoc[]
|
||||||
|
|
||||||
include::modules/http.asciidoc[]
|
include::modules/http.asciidoc[]
|
||||||
|
|
||||||
include::modules/indices.asciidoc[]
|
|
||||||
|
|
||||||
include::modules/network.asciidoc[]
|
include::modules/network.asciidoc[]
|
||||||
|
|
||||||
include::modules/node.asciidoc[]
|
include::modules/node.asciidoc[]
|
||||||
|
|
|
@ -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-breaker,Circuit breaker>>::
|
|
||||||
|
|
||||||
Circuit breakers set limits on memory usage to avoid out of memory exceptions.
|
|
||||||
|
|
||||||
<<modules-fielddata,Fielddata cache>>::
|
|
||||||
|
|
||||||
Set limits on the amount of heap used by the in-memory fielddata cache.
|
|
||||||
|
|
||||||
<<query-cache,Node query cache>>::
|
|
||||||
|
|
||||||
Configure the amount of heap used to cache queries results.
|
|
||||||
|
|
||||||
<<indexing-buffer,Indexing buffer>>::
|
|
||||||
|
|
||||||
Control the size of the buffer allocated to the indexing process.
|
|
||||||
|
|
||||||
<<shard-request-cache,Shard request cache>>::
|
|
||||||
|
|
||||||
Control the behaviour of the shard-level request cache.
|
|
||||||
|
|
||||||
<<recovery,Recovery>>::
|
|
||||||
|
|
||||||
Control the resource limits on the shard recovery process.
|
|
||||||
|
|
||||||
<<search-settings,Search Settings>>::
|
|
||||||
|
|
||||||
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[]
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[circuit-breaker]]
|
[[circuit-breaker]]
|
||||||
=== Circuit Breaker
|
=== Circuit breaker settings
|
||||||
|
|
||||||
Elasticsearch contains multiple circuit breakers used to prevent operations from
|
Elasticsearch contains multiple circuit breakers used to prevent operations from
|
||||||
causing an OutOfMemoryError. Each breaker specifies a limit for how much memory
|
causing an OutOfMemoryError. Each breaker specifies a limit for how much memory
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[modules-fielddata]]
|
[[modules-fielddata]]
|
||||||
=== Fielddata
|
=== Field data cache settings
|
||||||
|
|
||||||
The field data cache is used mainly when sorting on or computing aggregations
|
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
|
on a field. It loads all the field values to memory in order to provide fast
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[indexing-buffer]]
|
[[indexing-buffer]]
|
||||||
=== Indexing Buffer
|
=== Indexing buffer settings
|
||||||
|
|
||||||
The indexing buffer is used to store newly indexed documents. When it fills
|
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
|
up, the documents in the buffer are written to a segment on disk. It is divided
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[query-cache]]
|
[[query-cache]]
|
||||||
=== Node Query Cache
|
=== Node query cache settings
|
||||||
|
|
||||||
The results of queries used in the filter context are cached in the node query
|
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
|
cache for fast lookup. There is one queries cache per node that is shared by all
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[recovery]]
|
[[recovery]]
|
||||||
=== Index recovery
|
=== Index recovery settings
|
||||||
|
|
||||||
Peer recovery syncs data from a primary shard to a new or existing shard copy.
|
Peer recovery syncs data from a primary shard to a new or existing shard copy.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[shard-request-cache]]
|
[[shard-request-cache]]
|
||||||
=== Shard request cache
|
=== Shard request cache settings
|
||||||
|
|
||||||
When a search request is run against an index or against many indices, each
|
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
|
involved shard executes the search locally and returns its local results to
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-settings]]
|
[[search-settings]]
|
||||||
=== Search Settings
|
=== Search settings
|
||||||
|
|
||||||
The following expert settings can be set to manage global search and aggregation
|
The following expert settings can be set to manage global search and aggregation
|
||||||
limits.
|
limits.
|
||||||
|
|
|
@ -615,6 +615,19 @@ See <<ccs-gateway-seed-nodes>> and <<ccs-min-roundtrips>>.
|
||||||
See <<indices-create-data-stream>>, <<indices-get-data-stream>>, and
|
See <<indices-create-data-stream>>, <<indices-get-data-stream>>, and
|
||||||
<<indices-delete-data-stream>>.
|
<<indices-delete-data-stream>>.
|
||||||
|
|
||||||
|
[role="exclude",id="modules-indices"]
|
||||||
|
=== Indices module
|
||||||
|
|
||||||
|
See:
|
||||||
|
|
||||||
|
* <<circuit-breaker>>
|
||||||
|
* <<indexing-buffer>>
|
||||||
|
* <<modules-fielddata>>
|
||||||
|
* <<query-cache>>
|
||||||
|
* <<recovery>>
|
||||||
|
* <<search-settings>>
|
||||||
|
* <<shard-request-cache>>
|
||||||
|
|
||||||
[role="exclude",id="cat-transform"]
|
[role="exclude",id="cat-transform"]
|
||||||
=== cat transform API
|
=== cat transform API
|
||||||
|
|
||||||
|
|
|
@ -45,22 +45,36 @@ include::setup/jvm-options.asciidoc[]
|
||||||
|
|
||||||
include::setup/secure-settings.asciidoc[]
|
include::setup/secure-settings.asciidoc[]
|
||||||
|
|
||||||
include::setup/logging-config.asciidoc[]
|
|
||||||
|
|
||||||
include::settings/audit-settings.asciidoc[]
|
|
||||||
|
|
||||||
include::settings/ccr-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/ilm-settings.asciidoc[]
|
||||||
|
|
||||||
include::settings/license-settings.asciidoc[]
|
include::settings/license-settings.asciidoc[]
|
||||||
|
|
||||||
|
include::setup/logging-config.asciidoc[]
|
||||||
|
|
||||||
include::settings/ml-settings.asciidoc[]
|
include::settings/ml-settings.asciidoc[]
|
||||||
|
|
||||||
include::settings/monitoring-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/security-settings.asciidoc[]
|
||||||
|
|
||||||
|
include::settings/audit-settings.asciidoc[]
|
||||||
|
|
||||||
include::settings/slm-settings.asciidoc[]
|
include::settings/slm-settings.asciidoc[]
|
||||||
|
|
||||||
include::settings/sql-settings.asciidoc[]
|
include::settings/sql-settings.asciidoc[]
|
||||||
|
|
Loading…
Reference in New Issue