honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-25 01:19:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document 'max_size' parameter as shard size for rollover (#38750)

Browse Source 
It was not clear that this is *primary* shard size, not the entire shard size.

Resolves #37981
This commit is contained in:
Lee Hinman 2019-02-19 10:54:15 -07:00 committed by Lee Hinman
parent 0a9574c9d4
commit 80540a2fcc
3 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/ilm/policy-definitions.asciidoc
View File

@ -390,7 +390,7 @@ existing index meets one of the rollover conditions.
[options="header"]
|======
| Name | Required | Default | Description
| `max_size` | no | - | max index storage size.
| `max_size` | no | - | max primary shard index storage size.
See <<byte-units, Byte Units>>
for formatting
| `max_docs` | no | - | max number of documents an

4
docs/reference/ilm/using-policies-rollover.asciidoc
View File

@ -31,8 +31,8 @@ The rollover action takes the following parameters:
.`rollover` Action Parameters
|===
|Name |Description
|max_size |The maximum estimated size the index is allowed to grow
to. Defaults to `null`. Optional.
|max_size |The maximum estimated size the primary shard of the index is allowed
to grow to. Defaults to `null`. Optional.
|max_docs |The maximum number of document the index should
contain. Defaults to `null`. Optional.
|max_age |The maximum age of the index. Defaults to `null`. Optional.

9
docs/reference/indices/rollover-index.asciidoc
View File

@ -18,6 +18,15 @@ from the original (rolled-over) index.
In this scenario, the write index will have its rollover alias' `is_write_index` set to `false`, while the newly created index
will now have the rollover alias pointing to it as the write index with `is_write_index` as `true`.
The available conditions are:
.`conditions` parameters
|===
| Name | Description
| max_age | The maximum age of the index
| max_docs | The maximum number of documents the index should contain. This does not add documents multiple times for replicas
| max_size | The maximum estimated size of the primary shard of the index
|===
[source,js]
--------------------------------------------------