-
Notifications
You must be signed in to change notification settings - Fork 24.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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.
- Loading branch information
1 parent
a9e8a6a
commit 3fbf3b2
Showing
12 changed files
with
413 additions
and
13 deletions.
There are no files selected for viewing
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
4 changes: 2 additions & 2 deletions
4
docs/reference/autoscaling/apis/delete-autoscaling-policy.asciidoc
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
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
4 changes: 2 additions & 2 deletions
4
docs/reference/autoscaling/apis/get-autoscaling-policy.asciidoc
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
[role="xpack"] | ||
[testenv="enterprise"] | ||
[[autoscaling-deciders]] | ||
== Autoscaling deciders | ||
|
||
<<autoscaling-reactive-storage-decider,Reactive storage decider>>:: | ||
Estimate required storage capacity of current data set. Available for policies | ||
governing data nodes. | ||
|
||
<<autoscaling-proactive-storage-decider,Proactive storage decider>>:: | ||
Estimate required storage capacity based on current ingestion into hot nodes. | ||
Available for policies governing hot data nodes. | ||
|
||
<<autoscaling-machine-learning-decider,Machine learning decider>>:: | ||
Estimate required memory capacity based on machine learning jobs. | ||
Available for policies governing machine learning nodes. | ||
|
||
<<autoscaling-fixed-decider,Fixed decider>>:: | ||
A decider useful for testing, responding a fixed required capacity. | ||
|
||
include::deciders/reactive-storage-decider.asciidoc[] | ||
include::deciders/proactive-storage-decider.asciidoc[] | ||
include::deciders/machine-learning-decider.asciidoc[] | ||
include::deciders/fixed-decider.asciidoc[] |
2 changes: 2 additions & 0 deletions
2
docs/reference/autoscaling/autoscaling-designed-for-note.asciidoc
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[NOTE] | ||
Autoscaling is designed for indirect use by ECE/ESS and ECK. Direct use is not supported. |
62 changes: 62 additions & 0 deletions
62
docs/reference/autoscaling/deciders/fixed-decider.asciidoc
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
[role="xpack"] | ||
[testenv="enterprise"] | ||
[[autoscaling-fixed-decider]] | ||
=== Fixed decider | ||
|
||
experimental[] | ||
[NOTE] | ||
The purpose of this decider is purely for testing, it is not intended for | ||
production use. | ||
|
||
The `fixed` decider responds with a fixed required capacity. It is not enabled | ||
by default but can be enabled for any policy by explicitly configuring it. | ||
|
||
It has three configuration options: | ||
|
||
* storage: the node level storage necessary, default -1 (disabled). | ||
* memory: the node level memory necessary, default -1 (disabled). | ||
* nodes: the number of nodes to use for calculating total required capacities, | ||
default 1. | ||
|
||
[[autoscaling-fixed-decider-examples]] | ||
==== {api-examples-title} | ||
|
||
This example puts an autoscaling policy named `my_autoscaling_policy`, enabling | ||
and configuring the fixed decider. | ||
|
||
[source,console] | ||
-------------------------------------------------- | ||
PUT /_autoscaling/policy/my_autoscaling_policy | ||
{ | ||
"roles" : [ "data_hot" ], | ||
"deciders": { | ||
"fixed": { | ||
"storage": "1tb", | ||
"memory": "32gb", | ||
"nodes": 8 | ||
} | ||
} | ||
} | ||
-------------------------------------------------- | ||
// TEST | ||
|
||
The API returns the following result: | ||
|
||
[source,console-result] | ||
-------------------------------------------------- | ||
{ | ||
"acknowledged": true | ||
} | ||
-------------------------------------------------- | ||
|
||
////////////////////////// | ||
[source,console] | ||
-------------------------------------------------- | ||
DELETE /_autoscaling/policy/my_autoscaling_policy | ||
-------------------------------------------------- | ||
// TEST[continued] | ||
////////////////////////// | ||
|
||
|
Oops, something went wrong.