[DOCS] Add rollup V2 API docs#65398
[DOCS] Add rollup V2 API docs#65398jrodewig merged 8 commits intoelastic:masterfrom jrodewig:docs__rollup-api
Conversation
* Documents new `<index>/_rollup` API * Updates rollup APIs overview page * Enables rollups V2 in docs integ tests
| Time zone for the `field`. Valid values are ISO 8601 UTC offsets, such as | ||
| `+01:00` or `-08:00`, and IANA time zone IDs, such as `America/Los_Angeles`. | ||
| Defaults to `+00:00` (UTC). | ||
| ===== |
There was a problem hiding this comment.
delay is also a valid param for date_histogram but seems to be inert. Let me know if I should document it here.
There was a problem hiding this comment.
This is one of those WIP leaks. the config is being re-used, but you're right, the delay option is not intended to be used in this action, so it should not be mentioned
| [[legacy-rollup-apis]] | ||
| === Legacy rollup APIs | ||
|
|
||
| Prior to {es} 7.x, you could only create a rollup using a periodic cron jobs. |
There was a problem hiding this comment.
Prior to {es} 7.x, you could only create a rollup using a periodic cron jobs.
I'll update with the actual release version once we're closer to that.
|
Pinging @elastic/es-analytics-geo (Team:Analytics) |
|
Pinging @elastic/es-docs (Team:Docs) |
|
@talevy This is ready for a review at your convenience. I left a few questions and comments in the file changes. Thanks! |
| if (singleNode().testDistribution == DEFAULT) { | ||
| setting 'xpack.license.self_generated.type', 'trial' | ||
| setting 'indices.lifecycle.history_index_enabled', 'false' | ||
| if (BuildParams.isSnapshotBuild() == true) { |
There was a problem hiding this comment.
now that I am seeing this, I may have to change how I've done this in my PRs.
I feel it is safe to always set the system property in test clusters. I'll change all of them at a later point
talevy
left a comment
There was a problem hiding this comment.
woohoo! thank you for this. I will follow-up on the security role issue.
| [[legacy-rollup-apis]] | ||
| === Legacy rollup APIs | ||
|
|
||
| Prior to {es} 7.x, you could only create a rollup using a periodic cron jobs. |
There was a problem hiding this comment.
Good catch! Thanks!
Changes:
<index>/_rollupAPIRelates to #64900
Scope
This PR is focused on API reference documentation This PR does not include a more general overview or tutorial for rollups V2. I plan to cover those in later PRs. I also plan to open additional PR(s) to better label legacy rollup APIs.
Previews