Skip to content

Commit

Permalink
[DOCS] Intro for adding nodes (#37202)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Jan 15, 2019
1 parent a3c6af0 commit c614909
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/reference/setup.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,5 @@ include::setup/bootstrap-checks.asciidoc[]
include::setup/starting.asciidoc[]

include::setup/stopping.asciidoc[]

include::setup/add-nodes.asciidoc[]
37 changes: 37 additions & 0 deletions docs/reference/setup/add-nodes.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[[add-elasticsearch-nodes]]
== Adding nodes to your cluster

When you start an instance of {es}, you are starting a _node_. An {es} _cluster_
is a group of nodes that have the same `cluster.name` attribute. As nodes join
or leave a cluster, the cluster automatically reorganizes itself to evenly
distribute the data across the available nodes.

If you are running a single instance of {es}, you have a cluster of one node.
All primary shards reside on the single node. No replica shards can be
allocated, therefore the cluster state remains yellow. The cluster is fully
functional but is at risk of data loss in the event of a failure.

image::setup/images/elas_0202.png["A cluster with one node and three primary shards"]

You add nodes to a cluster to increase its capacity and reliability. By default,
a node is both a data node and eligible to be elected as the master node that
controls the cluster. You can also configure a new node for a specific purpose,
such as handling ingest requests. For more information, see
<<modules-node,Nodes>>.

When you add more nodes to a cluster, it automatically allocates replica shards.
When all primary and replica shards are active, the cluster state changes to
green.

image::setup/images/elas_0204.png["A cluster with three nodes"]

To add a node to a cluster:

. Set up a new {es} instance.
. Specify the name of the cluster in its `cluster.name` attribute. For example,
to add a node to the `logging-prod` cluster, set `cluster.name: "logging-prod"`
in `elasticsearch.yml`.
. Start {es}. The node automatically discovers and joins the specified cluster.

For more information about discovery and shard allocation, see
<<modules-discovery>> and <<modules-cluster>>.
Binary file added docs/reference/setup/images/elas_0202.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/reference/setup/images/elas_0204.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c614909

Please sign in to comment.