Skip to content
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.

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

[DOCS] Add rollup V2 API docs #65398

Merged
merged 8 commits into from
Nov 25, 2020
Merged

[DOCS] Add rollup V2 API docs #65398

merged 8 commits into from
Nov 25, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Nov 23, 2020

Changes:

  • Documents new <index>/_rollup API
  • Updates rollup APIs overview page
  • Enables rollups V2 in docs integ tests

Relates 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

@jrodewig jrodewig changed the title [DOCS] Add rollup API docs [DOCS] Add rollup V2 API docs Nov 23, 2020
@talevy talevy self-requested a review November 23, 2020 23:06
* 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).
=====
Copy link
Contributor Author

@jrodewig jrodewig Nov 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delay is also a valid param for date_histogram but seems to be inert. Let me know if I should document it here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jrodewig jrodewig added :StorageEngine/Rollup Turn fine-grained time-based data into coarser-grained data >docs General docs changes v7.11.0 v8.0.0 labels Nov 24, 2020
[[legacy-rollup-apis]]
=== Legacy rollup APIs

Prior to {es} 7.x, you could only create a rollup using a periodic cron jobs.
Copy link
Contributor Author

@jrodewig jrodewig Nov 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jrodewig jrodewig marked this pull request as ready for review November 24, 2020 14:07
@elasticmachine elasticmachine added Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team labels Nov 24, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-analytics-geo (Team:Analytics)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@jrodewig
Copy link
Contributor Author

@talevy This is ready for a review at your convenience. I left a few questions and comments in the file changes. Thanks!

@@ -52,6 +52,9 @@ testClusters.integTest {
if (singleNode().testDistribution == DEFAULT) {
setting 'xpack.license.self_generated.type', 'trial'
setting 'indices.lifecycle.history_index_enabled', 'false'
if (BuildParams.isSnapshotBuild() == true) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@talevy talevy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drop the "a"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! Thanks!

@jrodewig jrodewig merged commit a941c71 into elastic:master Nov 25, 2020
@jrodewig jrodewig deleted the docs__rollup-api branch November 25, 2020 16:16
jrodewig added a commit that referenced this pull request Nov 25, 2020
Changes:

* Documents new `<index>/_rollup` API
* Updates rollup APIs overview page
* Enables rollups V2 in docs integ tests
@jrodewig jrodewig mentioned this pull request Nov 25, 2020
26 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :StorageEngine/Rollup Turn fine-grained time-based data into coarser-grained data Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v7.11.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants