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.

Sign up for GitHub

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

Jump to bottom

Autoscaling frozen shards docs (#71583) #71747

Merged
merged 1 commit into from
Apr 15, 2021
Merged

Autoscaling frozen shards docs (#71583) #71747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/reference/autoscaling/autoscaling-deciders.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ governing data nodes.
Estimates required storage capacity based on current ingestion into hot nodes.
Available for policies governing hot data nodes.

<<autoscaling-frozen-shards-decider,Frozen shards decider>>::
Estimates required memory capacity based on number of frozen shards.
Available for policies governing frozen data nodes.

<<autoscaling-machine-learning-decider,Machine learning decider>>::
Estimates required memory capacity based on machine learning jobs.
Available for policies governing machine learning nodes.
Expand All @@ -20,5 +24,6 @@ Responds with a fixed required capacity. This decider is intended for testing on

include::deciders/reactive-storage-decider.asciidoc[]
include::deciders/proactive-storage-decider.asciidoc[]
include::deciders/frozen-shards-decider.asciidoc[]
include::deciders/machine-learning-decider.asciidoc[]
include::deciders/fixed-decider.asciidoc[]
16 changes: 16 additions & 0 deletions docs/reference/autoscaling/deciders/frozen-shards-decider.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[role="xpack"]
[[autoscaling-frozen-shards-decider]]
=== Frozen shards decider

The frozen shards decider (`frozen_shards`) calculates the memory required to search
the current frozen tier data set. Based on a required memory amount per shard, it
calculates the necessary memory in the frozen tier.

[[autoscaling-frozen-shards-decider-settings]]
==== Configuration settings

`memory_per_shard`::
(Optional, <<byte-units,byte value>>)
The memory needed per shard, in bytes. Defaults to 2000 shards per 64 GB node (roughly 32 MB per shard).
Notice that this is total memory, not heap, assuming that the Elasticsearch default heap sizing
mechanism is used and that nodes are not bigger than 64 GB.