Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 12 additions & 9 deletions docs/reference/modules/discovery/bootstrapping.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Starting an Elasticsearch cluster for the very first time requires the initial
set of <<master-node,master-eligible nodes>> to be explicitly defined on one or
more of the master-eligible nodes in the cluster. This is known as _cluster
bootstrapping_. This is only required the first time a cluster starts up.
Freshly-started nodes that are joining a running cluster obtain this
Freshly-started nodes that are joining a running cluster obtain this
information from the cluster's elected master.

The initial set of master-eligible nodes is defined in the
Expand All @@ -27,17 +27,20 @@ node:
if it is not possible to use the `node.name` of the node and there are
multiple nodes sharing a single IP address.

Do not set `cluster.initial_master_nodes` on master-ineligible nodes.

[IMPORTANT]
====
After the cluster has formed, remove the `cluster.initial_master_nodes` setting
from each node's configuration. It should not be set for master-ineligible
nodes, master-eligible nodes joining an existing cluster, or nodes which are
restarting.

If you leave `cluster.initial_master_nodes` in place once the cluster has
formed then there is a risk that a future misconfiguration may result in
bootstrapping a new cluster alongside your existing cluster. It may not be
possible to recover from this situation without losing data.
from each node's configuration and never set it again for this cluster. Do not
configure this setting on nodes joining an existing cluster. Do not configure
this setting on nodes which are restarting. Do not configure this setting when
performing a full-cluster restart.

If you leave `cluster.initial_master_nodes` in place once the cluster has formed
then there is a risk that a future misconfiguration may result in bootstrapping
a new cluster alongside your existing cluster. It may not be possible to recover
from this situation without losing data.
====

The simplest way to create a new cluster is for you to select one of your
Expand Down
7 changes: 5 additions & 2 deletions docs/reference/modules/discovery/discovery-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,11 @@ setting, see <<single-node-discovery>>.
Sets the initial set of master-eligible nodes in a brand-new cluster. By
default this list is empty, meaning that this node expects to join a cluster
that has already been bootstrapped. Remove this setting once the cluster has
formed. Do not use this setting when restarting nodes or when adding new nodes
to an existing cluster. See <<initial_master_nodes>>.
formed, and never set it again for this cluster. Do not configure this setting
on master-ineligible nodes. Do not configure this setting on nodes joining an
existing cluster. Do not configure this setting on nodes which are restarting.
Do not configure this setting when performing a full-cluster restart. See
<<initial_master_nodes>>.

[discrete]
==== Expert settings
Expand Down
13 changes: 6 additions & 7 deletions docs/reference/setup/bootstrap-checks.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -245,10 +245,9 @@ properties:
- `discovery.seed_providers`
- `cluster.initial_master_nodes`

Note that you should remove `cluster.initial_master_nodes` from the
configuration after the cluster has started for the first time. Do not use this
setting when restarting nodes or when adding new nodes to an existing cluster.
Instead, configure `discovery.seed_hosts` or `discovery.seed_providers`. If you
do not need any discovery configuration, for instance if running a single-node
cluster, set `discovery.seed_hosts: []` to disable discovery and satisfy this
bootstrap check.
Note that you must <<initial_master_nodes,remove `cluster.initial_master_nodes`
from the configuration of every node>> after the cluster has started for the
first time. Instead, configure `discovery.seed_hosts` or
`discovery.seed_providers`. If you do not need any discovery configuration, for
instance if running a single-node cluster, set `discovery.seed_hosts: []` to
disable discovery and satisfy this bootstrap check.
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,18 @@ first election. In <<dev-vs-prod-mode,development mode>>, with no discovery
settings configured, this step is performed automatically by the nodes
themselves.

Because auto-bootstrapping is <<modules-discovery-quorums,inherently
unsafe>>, when starting a new cluster in production
mode, you must explicitly list the master-eligible nodes whose votes should be
counted in the very first election. You set this list using the
`cluster.initial_master_nodes` setting.
Because auto-bootstrapping is <<modules-discovery-quorums,inherently unsafe>>,
when starting a new cluster in production mode, you must explicitly list the
master-eligible nodes whose votes should be counted in the very first election.
You set this list using the `cluster.initial_master_nodes` setting on every
master-eligible node. Do not configure this setting on master-ineligible nodes.

IMPORTANT: After the cluster forms successfully for the first time, remove the
`cluster.initial_master_nodes` setting from each node's configuration. Do not
use this setting when restarting a cluster or adding a new node to an existing
cluster.
`cluster.initial_master_nodes` setting from each node's configuration and never
set it again for this cluster. Do not configure this setting on nodes joining
an existing cluster. Do not configure this setting on nodes which are
restarting. Do not configure this setting when performing a full-cluster
restart. See <<modules-discovery-bootstrap-cluster>>.

[source,yaml]
--------------------------------------------------
Expand Down
Loading