modules.asciidoc 2.4 KB

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