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: move autoscaling source agent config #14947

Merged
merged 1 commit into from
Oct 19, 2022
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion website/content/tools/autoscaling/agent/apm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ apm "example-apm-plugin" {
}
```

### `apm` Parameters
## `apm` Parameters

- `args` `(array<string>: [])` - Specifies a set of arguments to pass to the
plugin binary when it is executed.
Expand Down
2 changes: 1 addition & 1 deletion website/content/tools/autoscaling/agent/http.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ http {
}
```

### `http` Parameters
## `http` Parameters

- `bind_address` `(string: "127.0.0.1")` - The HTTP address that the server will
bind to.
Expand Down
2 changes: 1 addition & 1 deletion website/content/tools/autoscaling/agent/nomad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ nomad {
}
```

### `nomad` Parameters
## `nomad` Parameters

- `address` `(string: "http://127.0.0.1:4646")` - The address of the Nomad server
in the form of `protocol://addr:port`.
Expand Down
26 changes: 25 additions & 1 deletion website/content/tools/autoscaling/agent/policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,14 @@ The `policy` block configures the Nomad Autoscaler's policy handling.
policy {
dir = "/opt/nomad-autoscaler/policies"
default_cooldown = "2m"

source "nomad" {
enabled = false
}
}
```

### `policy` Parameters
## `policy` Parameters

- `default_cooldown` `(string: "5m")` - The default cooldown that will be applied
to all scaling policies which do not specify a cooldown period.
Expand All @@ -28,3 +32,23 @@ policy {
interval.

- `dir` `(string: "")` - The path to a directory used to load scaling policies.

- `source` <code>([Source](#source-parameters))</code> - Configures policy
sources. The `nomad` source is enabled by default and the `file` source is
automatically enabled if `dir` is set.

### `source` Parameters

The `source` block is used to configure scaling policies sources. Supported
sources are `file` and `nomad`.

```hcl
policy {
source "nomad" {
enabled = false
}
}
```

- `enabled` `(bool: true)` - Defines if the scaling policy source should be
enabled or disabled.
2 changes: 1 addition & 1 deletion website/content/tools/autoscaling/agent/policy_eval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ policy_eval {
}
```

### `policy_eval` Parameters
## `policy_eval` Parameters

- `ack_timeout` `(string: "5m")` - The time limit that an eval must be ACK'd
before being considered NACK'd.
Expand Down
27 changes: 0 additions & 27 deletions website/content/tools/autoscaling/agent/source.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion website/content/tools/autoscaling/agent/strategy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ strategy "example-strategy-plugin" {
}
```

### `strategy` Parameters
## `strategy` Parameters

- `args` `(array<string>: [])` - Specifies a set of arguments to pass to the
plugin binary when it is executed.
Expand Down
2 changes: 1 addition & 1 deletion website/content/tools/autoscaling/agent/target.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ target "example-target-plugin" {
}
```

### `target` Parameters
## `target` Parameters

- `args` `(array<string>: [])` - Specifies a set of arguments to pass to the
plugin binary when it is executed.
Expand Down
14 changes: 7 additions & 7 deletions website/content/tools/autoscaling/agent/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ telemetry {
}
```

### `telemetry` Parameters
## `telemetry` Parameters

Due to the number of provider-specific parameters to the `telemetry` block, parameters
in this section are grouped by the telemetry provider.

### Common
### Common Parameters

The following options are available on all telemetry configurations.

Expand All @@ -37,7 +37,7 @@ The following options are available on all telemetry configurations.
- `collection_interval` `(duration: "1s")` - Specifies the time interval at which
the Nomad agent collects telemetry data.

### `statsite`
### `statsite` Parameters

These `telemetry` parameters apply to [Statsite][statsite].

Expand All @@ -50,7 +50,7 @@ telemetry {
}
```

### `statsd`
### `statsd` Parameters

These `telemetry` parameters apply to [StatsD][statsd].

Expand All @@ -63,7 +63,7 @@ telemetry {
}
```

### `datadog`
### `datadog` Parameters

These `telemetry` parameters apply to [DataDog statsd][datadog_statsd].

Expand All @@ -81,7 +81,7 @@ telemetry {
}
```

### `prometheus`
### `prometheus` Parameters

These `telemetry` parameters apply to [Prometheus][prometheus].

Expand All @@ -91,7 +91,7 @@ These `telemetry` parameters apply to [Prometheus][prometheus].
- `prometheus_retention_time` `(string: "24h")` - Specifies the amount of time that Prometheus
metrics are retained in memory.

### `circonus`
### `circonus` Parameters

These `telemetry` parameters apply to [Circonus][circonus].

Expand Down
4 changes: 0 additions & 4 deletions website/data/tools-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@
"title": "policy_eval",
"path": "autoscaling/agent/policy_eval"
},
{
"title": "source",
"path": "autoscaling/agent/source"
},
{
"title": "strategy",
"path": "autoscaling/agent/strategy"
Expand Down