Autoscaling APIs not experimental #67202

henningandersen · 2021-01-08T08:23:40Z

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.

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.

elasticmachine · 2021-01-11T09:02:58Z

Pinging @elastic/es-distributed (Team:Distributed)

elasticmachine · 2021-01-11T09:02:59Z

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

docs/reference/autoscaling/index.asciidoc

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

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 Parameters or Options section for configuration options in each decider reference page.

docs/reference/autoscaling/index.asciidoc

docs/reference/autoscaling/deciders/reactive-storage-decider.asciidoc

docs/reference/autoscaling/index.asciidoc

docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc

jrodewig · 2021-01-11T16:08:01Z

docs/reference/autoscaling/deciders/proactive-storage-decider.asciidoc

+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.


We'd typically put this in a Parameters or Options section with a def for forecast_window.

Did this in d0429bd

Co-authored-by: James Rodewig <[email protected]>

…sciidoc Co-authored-by: James Rodewig <[email protected]>

…asciidoc Co-authored-by: James Rodewig <[email protected]>

…sciidoc Co-authored-by: James Rodewig <[email protected]>

Co-authored-by: James Rodewig <[email protected]>

…gandersen/elasticsearch into docs_autoscaling_not_experimental

henningandersen · 2021-01-11T21:07:02Z

Thanks so much for the many suggestions, @jrodewig. I believe I addressed all of them. I added a Configuration settings section to the decider pages in d0429bd.

jrodewig

I left a few formatting nits, but this looks great to me. Thanks @henningandersen!

docs/reference/autoscaling/deciders/machine-learning-decider.asciidoc

Co-authored-by: James Rodewig <[email protected]>

Autoscaling APIs are no longer considered experimental and no longer hidden behind a feature flags. Updated the API specification accordingly. Relates #67202 and #65973

jasontedor

LGTM!

docs/reference/autoscaling/autoscaling-designed-for-note.asciidoc

Co-authored-by: Jason Tedor <[email protected]>

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 <[email protected]>

henningandersen added the >docs General docs changes label Jan 8, 2021

Autoscaling APIs not experimental

3fbf3b2

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 January 11, 2021 09:01

henningandersen added v7.11.1 v7.12.0 v8.0.0 :Distributed Coordination/Autoscaling labels Jan 11, 2021

henningandersen marked this pull request as ready for review January 11, 2021 09:02

elasticmachine added Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team labels Jan 11, 2021

henningandersen requested review from jasontedor and jrodewig January 11, 2021 09:03

henningandersen commented Jan 11, 2021

View reviewed changes

docs/reference/autoscaling/index.asciidoc Show resolved Hide resolved

henningandersen mentioned this pull request Jan 11, 2021

Autoscaling APIs marked public and stable #67235

Merged

jrodewig approved these changes Jan 11, 2021

View reviewed changes

henningandersen and others added 12 commits January 11, 2021 20:23

Update docs/reference/autoscaling/index.asciidoc

1d314b9

Co-authored-by: James Rodewig <[email protected]>

Update docs/reference/autoscaling/index.asciidoc

5e17d2a

Co-authored-by: James Rodewig <[email protected]>

Update docs/reference/autoscaling/deciders/reactive-storage-decider.a…

aa7412a

…sciidoc Co-authored-by: James Rodewig <[email protected]>

Update docs/reference/autoscaling/deciders/reactive-storage-decider.a…

8759aa4

…sciidoc Co-authored-by: James Rodewig <[email protected]>

Update docs/reference/autoscaling/deciders/proactive-storage-decider.…

0448818

…asciidoc Co-authored-by: James Rodewig <[email protected]>

Update docs/reference/autoscaling/deciders/proactive-storage-decider.…

e9a0f26

…asciidoc Co-authored-by: James Rodewig <[email protected]>

Update docs/reference/autoscaling/deciders/machine-learning-decider.a…

2d790c6

…sciidoc Co-authored-by: James Rodewig <[email protected]>

Apply suggestions from code review

6fd7d52

Co-authored-by: James Rodewig <[email protected]>

Add outer policies

9bcf5bb

Apply suggestions from code review

bf00912

Co-authored-by: James Rodewig <[email protected]>

Max bytes of storage/memory of a node.

94a0a21

Merge branch 'docs_autoscaling_not_experimental' of github.com:hennin…

734fa7c

…gandersen/elasticsearch into docs_autoscaling_not_experimental

henningandersen added 3 commits January 11, 2021 20:53

Designed for note.

b8c7350

Add short intro to policy, roles and deciders.

7ab0ebf

Add configuration settings sections.

d0429bd

jrodewig approved these changes Jan 11, 2021

View reviewed changes

Apply suggestions from code review

4695138

Co-authored-by: James Rodewig <[email protected]>

jasontedor approved these changes Jan 12, 2021

View reviewed changes

jasontedor reviewed Jan 12, 2021

View reviewed changes

docs/reference/autoscaling/autoscaling-designed-for-note.asciidoc Outdated Show resolved Hide resolved

Update docs/reference/autoscaling/autoscaling-designed-for-note.asciidoc

f5628d0

Co-authored-by: Jason Tedor <[email protected]>

henningandersen merged commit cc30ae8 into elastic:master Jan 12, 2021

henningandersen added the backport pending label Jan 12, 2021

henningandersen removed the backport pending label Jan 13, 2021

ywangd mentioned this pull request Feb 25, 2021

Documentation for operator privileges #68964

Merged

jakelandis added v8.0.0-alpha1 and removed v8.0.0 labels Jul 26, 2021

Autoscaling APIs not experimental #67202

Autoscaling APIs not experimental #67202

Uh oh!

Conversation

henningandersen commented Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticmachine commented Jan 11, 2021

Uh oh!

elasticmachine commented Jan 11, 2021

Uh oh!

Uh oh!

jrodewig left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jrodewig Jan 11, 2021

Choose a reason for hiding this comment

Uh oh!

henningandersen Jan 11, 2021

Choose a reason for hiding this comment

Uh oh!

henningandersen commented Jan 11, 2021

Uh oh!

jrodewig left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jasontedor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

henningandersen commented Jan 8, 2021 •

edited

Loading