From 8cd24a02991e977c7b63437e622ca459de428be8 Mon Sep 17 00:00:00 2001 From: James Rasell Date: Thu, 1 Apr 2021 11:31:56 +0200 Subject: [PATCH 1/2] docs: add fixed-value and pass-through autoscaler plugin docs. --- .../docs/autoscaling/plugins/strategy.mdx | 57 ++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/website/content/docs/autoscaling/plugins/strategy.mdx b/website/content/docs/autoscaling/plugins/strategy.mdx index a9e9eeaa955..ddb1c4b808f 100644 --- a/website/content/docs/autoscaling/plugins/strategy.mdx +++ b/website/content/docs/autoscaling/plugins/strategy.mdx @@ -28,7 +28,7 @@ strategy "target-value" { ### Policy Configuration Options ```hcl -check { +check "target-value-check" { ... strategy "target-value" { target = 20 @@ -44,6 +44,61 @@ check { metric should be considered. Small threshold values can lead to output fluctuation. +## Fixed Value Strategy Plugin + +The fixed value strategy receives a count value as an input configuration option +and returns a scaling action whose count to set the same value. This strategy is +useful in situations where there’s a known baseline for the infrastructure that +does not change often. + +### Agent Configuration Options + +```hcl +strategy "fixed-value" { + driver = "fixed-value" +} +``` + +### Policy Configuration Options + +```hcl +check "fixed-value-check" { + ... + strategy "fixed-value" { + value = 3 + } + ... +``` + +- `value` `(int: )` - The value used by the Nomad Autoscaler to set the + target count. + +## Pass Through Strategy Plugin + +The pass-through strategy is a very simple, yet useful strategy. It does not +add any extra computation on top of the metric query result, and instead uses +the APM query result as the scaling count. This allows the Nomad Autoscaler to +be integrated into systems where the scaling computation is done externally like +an edge router, or easily derived from a query such as running one allocation per +item in a queue. + +### Agent Configuration Options + +```hcl +strategy "pass-through" { + driver = "pass-through" +} +``` + +### Policy Configuration Options + +```hcl +check "pass-through-check" { + ... + strategy "pass-through" {} + ... +``` + ## Dynamic Application Sizing Average Strategy Plugin From e57769aa8d30250319d4b0e7e1526a049b97e0d7 Mon Sep 17 00:00:00 2001 From: Luiz Aoqui Date: Thu, 1 Apr 2021 16:04:18 -0400 Subject: [PATCH 2/2] docs: update autoscaler strategy docs --- .../content/docs/autoscaling/plugins/strategy.mdx | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/website/content/docs/autoscaling/plugins/strategy.mdx b/website/content/docs/autoscaling/plugins/strategy.mdx index ddb1c4b808f..85866cfbb9b 100644 --- a/website/content/docs/autoscaling/plugins/strategy.mdx +++ b/website/content/docs/autoscaling/plugins/strategy.mdx @@ -47,7 +47,7 @@ check "target-value-check" { ## Fixed Value Strategy Plugin The fixed value strategy receives a count value as an input configuration option -and returns a scaling action whose count to set the same value. This strategy is +and returns a scaling action whose count is set to the same value. This strategy is useful in situations where there’s a known baseline for the infrastructure that does not change often. @@ -73,14 +73,16 @@ check "fixed-value-check" { - `value` `(int: )` - The value used by the Nomad Autoscaler to set the target count. -## Pass Through Strategy Plugin +## Pass-Through Strategy Plugin The pass-through strategy is a very simple, yet useful strategy. It does not add any extra computation on top of the metric query result, and instead uses -the APM query result as the scaling count. This allows the Nomad Autoscaler to -be integrated into systems where the scaling computation is done externally like -an edge router, or easily derived from a query such as running one allocation per -item in a queue. +the APM query result as the scaling count. It doesn't have any configuration +options. + +This allows the Nomad Autoscaler to be integrated into systems where the +scaling computation is done externally like an edge router, or easily derived +from a query such as running one allocation per item in a queue. ### Agent Configuration Options