Skip to content

Commit 2082dae

Browse files
authored
Remove max_primary_shard_size from rollover examples (#9805)
The list of supported conditions is correct, but the examples use `max_primary_shard_size` which is not supported. This change uses `max_size` in the examples instead. There was also a formatting error on a table. Signed-off-by: Andrew Ross <[email protected]>
1 parent 56042ab commit 2082dae

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

_api-reference/index-apis/rollover.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ The object body supports the following parameters.
9191

9292
Parameter | Data type | Description
9393
:--- | :--- | :---
94-
| `max_age` | Time units | Triggers a rollover after the maximum elapsed time since index creation is reached. The elapsed time is always calculated since the index creation time, even if the index origination date is configured to a custom date, such as when using the `index.lifecycle.parse_origination_date` or `index.lifecycle.origination_date` settings. Optional. |
94+
`max_age` | Time units | Triggers a rollover after the maximum elapsed time since index creation is reached. The elapsed time is always calculated since the index creation time, even if the index origination date is configured to a custom date, such as when using the `index.lifecycle.parse_origination_date` or `index.lifecycle.origination_date` settings. Optional. |
9595
`max_docs` | Integer | Triggers a rollover after the specified maximum number of documents, excluding documents added since the last refresh and documents in replica shards. Optional.
9696
`max_size` | Byte units | Triggers a rollover when the index reaches a specified size, calculated as the total size of all primary shards. Replicas are not counted. Use the `_cat indices` API and check the `pri.store.size` value to see the current index size. Optional.
9797

@@ -105,7 +105,7 @@ The following examples illustrate using the Rollover Index API. A rollover occur
105105

106106
- The index was created 5 or more days ago.
107107
- The index contains 500 or more documents.
108-
- The index's largest primary shard is 100 GB or larger.
108+
- The index is 100 GB or larger.
109109

110110
### Rolling over a data stream
111111

@@ -117,7 +117,7 @@ POST my-data-stream/_rollover
117117
"conditions": {
118118
"max_age": "5d",
119119
"max_docs": 500,
120-
"max_primary_shard_size": "100gb"
120+
"max_size": "100gb"
121121
}
122122
}
123123
```
@@ -148,7 +148,7 @@ POST my-alias/_rollover
148148
"conditions": {
149149
"max_age": "5d",
150150
"max_docs": 500,
151-
"max_primary_shard_size": "100gb"
151+
"max_size": "100gb"
152152
}
153153
}
154154
```
@@ -171,7 +171,7 @@ POST my-alias/_rollover
171171

172172
## Example response
173173

174-
OpenSearch returns the following response confirming that all conditions except `max_primary_shard_size` were met:
174+
OpenSearch returns the following response confirming that all conditions except `max_size` were met:
175175

176176
```json
177177
{
@@ -184,7 +184,7 @@ OpenSearch returns the following response confirming that all conditions except
184184
"conditions": {
185185
"[max_age: 5d]": true,
186186
"[max_docs: 500]": true,
187-
"[max_primary_shard_size: 100gb]": false
187+
"[max_size: 100gb]": false
188188
}
189189
}
190190
```

0 commit comments

Comments
 (0)