You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: _api-reference/index-apis/rollover.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,7 +91,7 @@ The object body supports the following parameters.
91
91
92
92
Parameter | Data type | Description
93
93
:--- | :--- | :---
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. |
95
95
`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.
96
96
`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.
97
97
@@ -105,7 +105,7 @@ The following examples illustrate using the Rollover Index API. A rollover occur
105
105
106
106
- The index was created 5 or more days ago.
107
107
- 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.
109
109
110
110
### Rolling over a data stream
111
111
@@ -117,7 +117,7 @@ POST my-data-stream/_rollover
117
117
"conditions": {
118
118
"max_age": "5d",
119
119
"max_docs": 500,
120
-
"max_primary_shard_size": "100gb"
120
+
"max_size": "100gb"
121
121
}
122
122
}
123
123
```
@@ -148,7 +148,7 @@ POST my-alias/_rollover
148
148
"conditions": {
149
149
"max_age": "5d",
150
150
"max_docs": 500,
151
-
"max_primary_shard_size": "100gb"
151
+
"max_size": "100gb"
152
152
}
153
153
}
154
154
```
@@ -171,7 +171,7 @@ POST my-alias/_rollover
171
171
172
172
## Example response
173
173
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:
175
175
176
176
```json
177
177
{
@@ -184,7 +184,7 @@ OpenSearch returns the following response confirming that all conditions except
0 commit comments