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.

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

docs: add fixed-value and pass-through autoscaler plugin docs. #10278

Merged
merged 2 commits into from
Apr 1, 2021
Merged
Changes from all commits
Commits
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
59 changes: 58 additions & 1 deletion website/content/docs/autoscaling/plugins/strategy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ strategy "target-value" {
### Policy Configuration Options

```hcl
check {
check "target-value-check" {
...
strategy "target-value" {
target = 20
Expand All @@ -44,6 +44,63 @@ 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 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.

### 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: <required>)` - 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. 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

```hcl
strategy "pass-through" {
driver = "pass-through"
}
```

### Policy Configuration Options

```hcl
check "pass-through-check" {
...
strategy "pass-through" {}
...
```

## Dynamic Application Sizing Average Strategy Plugin

<EnterpriseAlert>
Expand Down