elasticsearch/docs/reference/autoscaling/deciders/fixed-decider.asciidoc
Henning Andersen 8779330638
[DOCS] Document autoscaling processors (#88248)
Add documentation for new `processors` response in autoscaling capacity API.

Relates #87895
2022-07-05 13:51:51 +02:00

71 lines
1.7 KiB
Text

[role="xpack"]
[[autoscaling-fixed-decider]]
=== Fixed decider
experimental[]
[WARNING]
The fixed decider is intended for testing only. Do not use this decider in production.
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.
==== Configuration settings
`storage`::
(Optional, <<byte-units,byte value>>)
Required amount of node-level storage. Defaults to `-1` (disabled).
`memory`::
(Optional, <<byte-units,byte value>>)
Required amount of node-level memory. Defaults to `-1` (disabled).
`processors`::
(Optional, float)
Required number of processors. Defaults to disabled.
`nodes`::
(Optional, integer)
Number of nodes to use when calculating capacity. Defaults to `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",
"processors": 2.3,
"nodes": 8
}
}
}
--------------------------------------------------
// TEST
The API returns the following result:
[source,console-result]
--------------------------------------------------
{
"acknowledged": true
}
--------------------------------------------------
//////////////////////////
[source,console]
--------------------------------------------------
DELETE /_autoscaling/policy/my_autoscaling_policy
--------------------------------------------------
// TEST[continued]
//////////////////////////