2013-08-28 19:24:34 -04:00
|
|
|
[[modules]]
|
|
|
|
= Modules
|
|
|
|
|
2015-06-22 17:49:45 -04:00
|
|
|
[partintro]
|
|
|
|
--
|
|
|
|
This section contains modules responsible for various aspects of the functionality in Elasticsearch. Each module has settings which may be:
|
|
|
|
|
|
|
|
_static_::
|
|
|
|
|
|
|
|
These settings must be set at the node level, either in the
|
|
|
|
`elasticsearch.yml` file, or as an environment variable or on the command line
|
|
|
|
when starting a node. They must be set on every relevant node in the cluster.
|
|
|
|
|
|
|
|
_dynamic_::
|
|
|
|
|
|
|
|
These settings can be dynamically updated on a live cluster with the
|
|
|
|
<<cluster-update-settings,cluster-update-settings>> API.
|
|
|
|
|
|
|
|
The modules in this section are:
|
|
|
|
|
2018-12-20 08:02:44 -05:00
|
|
|
<<modules-discovery,Discovery and cluster formation>>::
|
2015-06-22 17:49:45 -04:00
|
|
|
|
2018-12-20 08:02:44 -05:00
|
|
|
How nodes discover each other, elect a master and form a cluster.
|
2015-06-22 17:49:45 -04:00
|
|
|
|
2018-12-20 08:02:44 -05:00
|
|
|
<<modules-cluster,Shard allocation and cluster-level routing>>::
|
2015-06-22 17:49:45 -04:00
|
|
|
|
2018-12-20 08:02:44 -05:00
|
|
|
Settings to control where, when, and how shards are allocated to nodes.
|
2015-06-22 17:49:45 -04:00
|
|
|
|
|
|
|
<<modules-gateway,Gateway>>::
|
|
|
|
|
|
|
|
How many nodes need to join the cluster before recovery can start.
|
|
|
|
|
|
|
|
<<modules-http,HTTP>>::
|
|
|
|
|
|
|
|
Settings to control the HTTP REST interface.
|
|
|
|
|
|
|
|
<<modules-indices,Indices>>::
|
|
|
|
|
|
|
|
Global index-related settings.
|
|
|
|
|
|
|
|
<<modules-network,Network>>::
|
|
|
|
|
|
|
|
Controls default network settings.
|
|
|
|
|
|
|
|
<<modules-node,Node client>>::
|
|
|
|
|
|
|
|
A Java node client joins the cluster, but doesn't hold data or act as a master node.
|
2016-11-21 22:13:25 -05:00
|
|
|
|
2015-06-22 17:49:45 -04:00
|
|
|
<<modules-plugins,Plugins>>::
|
|
|
|
|
|
|
|
Using plugins to extend Elasticsearch.
|
|
|
|
|
|
|
|
<<modules-snapshots,Snapshot/Restore>>::
|
|
|
|
|
|
|
|
Backup your data with snapshot/restore.
|
|
|
|
|
|
|
|
<<modules-threadpool,Thread pools>>::
|
|
|
|
|
|
|
|
Information about the dedicated thread pools used in Elasticsearch.
|
|
|
|
|
|
|
|
<<modules-transport,Transport>>::
|
|
|
|
|
|
|
|
Configure the transport networking layer, used internally by Elasticsearch
|
|
|
|
to communicate between nodes.
|
2016-01-31 08:54:17 -05:00
|
|
|
|
2018-10-20 11:18:27 -04:00
|
|
|
<<modules-remote-clusters, Remote clusters>>::
|
2018-10-20 09:04:48 -04:00
|
|
|
|
|
|
|
Remote clusters are used in features that work by connecting across clusters
|
|
|
|
on the transport layer.
|
2017-01-05 10:10:34 -05:00
|
|
|
|
2019-03-15 10:54:45 -04:00
|
|
|
<<modules-cross-cluster-search, {ccs-cap}>>::
|
2017-01-05 10:10:34 -05:00
|
|
|
|
2019-03-15 10:54:45 -04:00
|
|
|
{ccs-cap} enables executing search requests across more than one cluster
|
|
|
|
without joining them and acts as a federated client across them.
|
2015-06-22 17:49:45 -04:00
|
|
|
--
|
|
|
|
|
|
|
|
|
2013-08-28 19:24:34 -04:00
|
|
|
include::modules/discovery.asciidoc[]
|
|
|
|
|
2018-12-20 08:02:44 -05:00
|
|
|
include::modules/cluster.asciidoc[]
|
|
|
|
|
2013-08-28 19:24:34 -04:00
|
|
|
include::modules/gateway.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/http.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/indices.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/network.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/node.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/plugins.asciidoc[]
|
|
|
|
|
2015-06-22 17:49:45 -04:00
|
|
|
include::modules/snapshots.asciidoc[]
|
|
|
|
|
2013-08-28 19:24:34 -04:00
|
|
|
include::modules/threadpool.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/transport.asciidoc[]
|
|
|
|
|
2018-10-20 08:33:59 -04:00
|
|
|
include::modules/remote-clusters.asciidoc[]
|