Skip to content

Commit 4852f34

Browse files
committed
Docs adjustments
1 parent 21f87f2 commit 4852f34

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

docs/reference/cluster/health.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
The cluster health API allows to get a very simple status on the health
55
of the cluster. For example, on a quiet single node cluster with a single index
6-
with 5 shards and one replica, this:
6+
with one shard and one replica, this:
77

88
[source,js]
99
--------------------------------------------------

docs/reference/getting-started.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Replication is important for two primary reasons:
9595
To summarize, each index can be split into multiple shards. An index can also be replicated zero (meaning no replicas) or more times. Once replicated, each index will have primary shards (the original shards that were replicated from) and replica shards (the copies of the primary shards).
9696
The number of shards and replicas can be defined per index at the time the index is created. After the index is created, you may change the number of replicas dynamically anytime but you cannot change the number of shards after-the-fact.
9797

98-
By default, each index in Elasticsearch is allocated 5 primary shards and 1 replica which means that if you have at least two nodes in your cluster, your index will have 5 primary shards and another 5 replica shards (1 complete replica) for a total of 10 shards per index.
98+
By default, each index in Elasticsearch is allocated one primary shard and one replica which means that if you have at least two nodes in your cluster, your index will have one primary shard and another replica shard (one complete replica) for a total of two shards per index.
9999

100100
NOTE: Each Elasticsearch shard is a Lucene index. There is a maximum number of documents you can have in a single Lucene index. As of https://issues.apache.org/jira/browse/LUCENE-5843[`LUCENE-5843`], the limit is `2,147,483,519` (= Integer.MAX_VALUE - 128) documents.
101101
You can monitor shard sizes using the {ref}/cat-shards.html[`_cat/shards`] API.
@@ -370,7 +370,7 @@ yellow open customer 95SQ4TSUT7mWBT7VNHH67A 1 1 0 0
370370
--------------------------------------------------
371371
// TESTRESPONSE[s/95SQ4TSUT7mWBT7VNHH67A/.+/ s/260b/\\d+\\.?\\d?k?b/ _cat]
372372

373-
The results of the second command tells us that we now have 1 index named customer and it has 5 primary shards and 1 replica (the defaults) and it contains 0 documents in it.
373+
The results of the second command tells us that we now have one index named customer and it has one primary shard and one replica (the defaults) and it contains zero documents in it.
374374

375375
You might also notice that the customer index has a yellow health tagged to it. Recall from our previous discussion that yellow means that some replicas are not (yet) allocated. The reason this happens for this index is because Elasticsearch by default created one replica for this index. Since we only have one node running at the moment, that one replica cannot yet be allocated (for high availability) until a later point in time when another node joins the cluster. Once that replica gets allocated onto a second node, the health status for this index will turn to green.
376376

docs/reference/glossary.asciidoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,13 @@
105105
you index a document, it is indexed first on the primary shard, then
106106
on all <<glossary-replica-shard,replicas>> of the primary shard.
107107
+
108-
By default, an <<glossary-index,index>> has 5 primary shards. You can
109-
specify fewer or more primary shards to scale the number of
110-
<<glossary-document,documents>> that your index can handle.
108+
By default, an <<glossary-index,index>> has one primary shard. You can specify
109+
more primary shards to scale the number of <<glossary-document,documents>>
110+
that your index can handle.
111111
+
112-
You cannot change the number of primary shards in an index, once the
113-
index is created.
112+
You cannot change the number of primary shards in an index, once the index is
113+
index is created. However, an index can be split into a new index using the
114+
<<indices-split-index, split API>>.
114115
+
115116
See also <<glossary-routing,routing>>
116117

0 commit comments

Comments
 (0)