Skip to content

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

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
merged 1 commit into from
Feb 19, 2019
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion docs/reference/ilm/policy-definitions.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ilm/using-policies-rollover.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 9 additions & 0 deletions docs/reference/indices/rollover-index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
--------------------------------------------------
Expand Down