Skip to content

[DOCS] Relocate discovery module content #56611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrodewig merged 3 commits into from
May 12, 2020
Merged

[DOCS] Relocate discovery module content #56611

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf73646
[DOCS] Relocate discovery module content
jrodewig May 12, 2020
3068f21
improve redirects
jrodewig May 12, 2020
0a3bff0
correct grouping
jrodewig May 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/reference/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ include::mapping.asciidoc[]

include::analysis.asciidoc[]

include::modules.asciidoc[]

include::index-modules.asciidoc[]

include::ingest.asciidoc[]
Expand Down
27 changes: 0 additions & 27 deletions docs/reference/modules.asciidoc
View file
Open in desktop

This file was deleted.

22 changes: 10 additions & 12 deletions docs/reference/modules/discovery.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
[[modules-discovery]]
== Discovery and cluster formation

The discovery and cluster formation module is responsible for discovering
The discovery and cluster formation processes are responsible for discovering
nodes, electing a master, forming a cluster, and publishing the cluster state
each time it changes. It is integrated with other modules. For example, all
communication between nodes is done using the <<modules-transport,transport>>
module. This module is divided into the following sections:
each time it changes. All communication between nodes is done using the
<<modules-transport,transport>> layer.

The following processes and settings are part of discovery and cluster
formation:

<<modules-discovery-hosts-providers>>::

Expand All @@ -15,17 +17,17 @@ module. This module is divided into the following sections:

<<modules-discovery-quorums>>::

This section describes how {es} uses a quorum-based voting mechanism to
How {es} uses a quorum-based voting mechanism to
make decisions even if some nodes are unavailable.

<<modules-discovery-voting>>::

This section describes the concept of voting configurations, which {es}
automatically updates as nodes leave and join the cluster.
How {es} automatically updates voting configurations as nodes leave and join
a cluster.

<<modules-discovery-bootstrap-cluster>>::

Bootstrapping a cluster is required when an Elasticsearch cluster starts up
Bootstrapping a cluster is required when an {es} cluster starts up
for the very first time. In <<dev-vs-prod-mode,development mode>>, with no
discovery settings configured, this is automatically performed by the nodes
themselves. As this auto-bootstrapping is
Expand Down Expand Up @@ -67,10 +69,6 @@ include::discovery/voting.asciidoc[]

include::discovery/bootstrapping.asciidoc[]

include::discovery/adding-removing-nodes.asciidoc[]

include::discovery/publishing.asciidoc[]

include::discovery/fault-detection.asciidoc[]

include::discovery/discovery-settings.asciidoc[]
134 changes: 0 additions & 134 deletions docs/reference/modules/discovery/adding-removing-nodes.asciidoc
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion docs/reference/modules/discovery/discovery-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[[modules-discovery-settings]]
=== Discovery and cluster formation settings

Discovery and cluster formation are affected by the following settings:
<<modules-discovery,Discovery and cluster formation>> are affected by the
following settings:

`discovery.seed_hosts`::
+
Expand Down
46 changes: 45 additions & 1 deletion docs/reference/redirects.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,4 +527,48 @@ See <<cluster-shard-allocation-filtering>>.
[role="exclude",id="misc-cluster"]
=== Miscellaneous cluster settings

See <<misc-cluster-settings>>.
See <<misc-cluster-settings>>.

[role="exclude",id="modules"]
=== Modules

This page has been removed.

For circuit breaker settings, see <<circuit-breaker>>.
Copy link
Contributor

@debadair debadair May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd probably pare this down to a simple list instead of repeating "For xyz settings" for each xref. Something like:

See <<settings, Configuring Elasticsearch>> for settings information:

* <<modules-cluster>>
* <<modules-dicsovery-settings>>
...

OTOH, this isn't a high-traffic page, so...leaving it as-is is fine, too.

Copy link
Contributor Author

@jrodewig jrodewig May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good idea and much more readable IMO. Updated with 3068f21. Thanks for the suggestion!


For cluster-level shard allocation and routing settings, see <<modules-cluster>>.

For information about discovery and cluster formation, see <<modules-discovery-settings>>.

For field data cache settings, see <<modules-fielddata>>.

For HTTP settings, see <<modules-http>>.

For index recovery settings, see <<recovery>>.

For indexing buffer settings, see <<indexing-buffer>>.

For information about the transport layer, see <<modules-transport>>.

For information about thread pools, see <<modules-threadpool>>.

For local gateway settings, see <<modules-gateway>>.

For network settings, see <<modules-network>>.

For information about node types and settings, see <<modules-node>>.

For node query cache settings, see <<query-cache>>.

For information about plugins, see <<modules-plugins>>.

For information about remote clusters, see <<modules-remote-clusters>>.

For search settings, see <<search-settings>>.

For shard request cache settings, see <<shard-request-cache>>.

[role="exclude",id="modules-discovery-adding-removing-nodes"]
=== Adding and removing nodes

See <<add-elasticsearch-nodes>>.
4 changes: 4 additions & 0 deletions docs/reference/setup.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ include::modules/cluster.asciidoc[]

include::settings/ccr-settings.asciidoc[]

include::modules/discovery/discovery-settings.asciidoc[]

include::modules/indices/fielddata.asciidoc[]

include::modules/http.asciidoc[]
Expand Down Expand Up @@ -109,6 +111,8 @@ include::setup/starting.asciidoc[]

include::setup/stopping.asciidoc[]

include::modules/discovery.asciidoc[]

include::setup/add-nodes.asciidoc[]

include::setup/restart-cluster.asciidoc[]
Expand Down
Loading