Autoscaling APIs not experimental #67202
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We no longer regard the autoscaling APIs experimental though they are only intended for use by ESS/ECE/ECK. This commit updates the docs to reflect this and adds a minimal set of documentation for the feature.
henningandersen
force-pushed
the
docs_autoscaling_not_experimental
branch
from
d1d5761
to
3fbf3b2
Compare
elasticmachine
added
Team:Distributed
|
Pinging @elastic/es-distributed (Team:Distributed) |
|
Pinging @elastic/es-docs (Team:Docs) |
henningandersen
commented
Jan 11, 2021
henningandersen
added a commit
to henningandersen/elasticsearch
that referenced
this pull request
Jan 11, 2021
Autoscaling APIs are no longer considered experimental and no longer hidden behind a feature flags. Updated the API specification accordingly. Relates elastic#67202 and elastic#65973
jrodewig
approved these changes
Jan 11, 2021
There was a problem hiding this comment.
This looks good overall. I left several suggestions, but feel free to ignore those if wanted.
Two larger pieces of non-blocking feedback:
- I'd add a sentence or two about what deciders are and how autoscaling uses them to the top-level page. There isn't a conceptual intro to deciders in the docs currently.
- I'd create a separate
ParametersorOptionssection for configuration options in each decider reference page.
docs/reference/autoscaling/deciders/reactive-storage-decider.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/autoscaling/deciders/reactive-storage-decider.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc
Outdated
Show resolved
Hide resolved
Comment on lines
10
to
15
| single configuration option `forecast_window` is available, defaulting to 30 | ||
| minutes. | ||
|
|
||
| The estimation of expected additional data is based on past indexing that | ||
| occurred within the `forecast_window`, i.e., by default the last 30 minutes. | ||
| Only indexing into data streams contributes to the estimate. |
There was a problem hiding this comment.
We'd typically put this in a Parameters or Options section with a def for forecast_window.
There was a problem hiding this comment.
Did this in d0429bd
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
…sciidoc Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
…sciidoc Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
…asciidoc Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
…asciidoc Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
…sciidoc Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
…gandersen/elasticsearch into docs_autoscaling_not_experimental
jrodewig
approved these changes
Jan 11, 2021
There was a problem hiding this comment.
I left a few formatting nits, but this looks great to me. Thanks @henningandersen!
docs/reference/autoscaling/deciders/machine-learning-decider.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/autoscaling/deciders/machine-learning-decider.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/autoscaling/deciders/machine-learning-decider.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/autoscaling/deciders/machine-learning-decider.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
henningandersen
added a commit
that referenced
this pull request
Jan 12, 2021
henningandersen
added a commit
that referenced
this pull request
Jan 12, 2021
henningandersen
added a commit
that referenced
this pull request
Jan 12, 2021
jasontedor
reviewed
Jan 12, 2021
docs/reference/autoscaling/autoscaling-designed-for-note.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Jason Tedor <jason@tedor.me>
henningandersen
added a commit
that referenced
this pull request
Jan 13, 2021
We no longer regard the autoscaling APIs experimental though they are only intended for use by ESS/ECE/ECK. This commit updates the docs to reflect this and adds a minimal set of documentation for the feature. Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
henningandersen
added a commit
that referenced
this pull request
Jan 13, 2021
We no longer regard the autoscaling APIs experimental though they are only intended for use by ESS/ECE/ECK. This commit updates the docs to reflect this and adds a minimal set of documentation for the feature. Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We no longer regard the autoscaling APIs experimental though they are
only intended for use by ESS/ECE/ECK. This commit updates the docs
to reflect this and adds a minimal set of documentation for the
feature.