diff --git a/docs/guides/README.md b/docs/guides/README.md index b90f94e..ce95762 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -1 +1,3 @@ # Sherpa Guides + +Welcome to the Sherpa guides. The guides provide examples for common Sherpa workflows and actions for both users and operators of Nomad clusters running Sherpa. \ No newline at end of file diff --git a/docs/guides/autoscaler.md b/docs/guides/autoscaler.md index 90c4329..d1831cd 100644 --- a/docs/guides/autoscaler.md +++ b/docs/guides/autoscaler.md @@ -1,3 +1,3 @@ # AutoScaler -Sherpa can run using an internal autoscaler which uses Nomad job resource utilization stats to determine whether a group should be scaled or not. +Sherpa can run using an internal autoscaler which uses Nomad job resource utilization stats to determine whether a group is eligible for scaling. The autoscaler will iterate stored policies, performing calculations to figure out each job group CPU and memory consummation. If consumption is above 80% or below 20%, Sherpa will request scaling of the job group as long as the scaling policies limits are not violated.