2017-12-18 21:16:33 +00:00
|
|
|
---
|
2020-02-06 23:45:31 +00:00
|
|
|
layout: docs
|
|
|
|
|
page_title: autopilot Stanza - Agent Configuration
|
|
|
|
|
description: >-
|
|
|
|
|
The "autopilot" stanza configures the Nomad agent to configure Autopilot
|
|
|
|
|
behavior.
|
2017-12-18 21:16:33 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `autopilot` Stanza
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
<Placement groups={['autopilot']} />
|
2017-12-18 21:16:33 +00:00
|
|
|
|
|
|
|
|
The `autopilot` stanza configures the Nomad agent to configure Autopilot behavior.
|
2020-09-29 16:48:32 +00:00
|
|
|
For more information about Autopilot, see the [Autopilot Guide](https://learn.hashicorp.com/tutorials/nomad/autopilot).
|
2017-12-18 21:16:33 +00:00
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
autopilot {
|
2020-09-09 13:37:39 +00:00
|
|
|
cleanup_dead_servers = true
|
|
|
|
|
last_contact_threshold = "200ms"
|
|
|
|
|
max_trailing_logs = 250
|
2017-12-18 21:16:33 +00:00
|
|
|
server_stabilization_time = "10s"
|
2020-09-09 13:37:39 +00:00
|
|
|
enable_redundancy_zones = false
|
2018-01-30 03:53:34 +00:00
|
|
|
disable_upgrade_migration = false
|
2020-09-09 13:37:39 +00:00
|
|
|
enable_custom_upgrades = false
|
2017-12-18 21:16:33 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## `autopilot` Parameters
|
|
|
|
|
|
|
|
|
|
- `cleanup_dead_servers` `(bool: true)` - Specifies automatic removal of dead
|
|
|
|
|
server nodes periodically and whenever a new server is added to the cluster.
|
|
|
|
|
|
|
|
|
|
- `last_contact_threshold` `(string: "200ms")` - Specifies the maximum amount of
|
|
|
|
|
time a server can go without contact from the leader before being considered
|
|
|
|
|
unhealthy. Must be a duration value such as `10s`.
|
|
|
|
|
|
|
|
|
|
- `max_trailing_logs` `(int: 250)` specifies the maximum number of log entries
|
|
|
|
|
that a server can trail the leader by before being considered unhealthy.
|
|
|
|
|
|
|
|
|
|
- `server_stabilization_time` `(string: "10s")` - Specifies the minimum amount of
|
|
|
|
|
time a server must be stable in the 'healthy' state before being added to the
|
|
|
|
|
cluster. Only takes effect if all servers are running Raft protocol version 3
|
|
|
|
|
or higher. Must be a duration value such as `30s`.
|
|
|
|
|
|
2018-01-30 03:53:34 +00:00
|
|
|
- `enable_redundancy_zones` `(bool: false)` - (Enterprise-only) Controls whether
|
|
|
|
|
Autopilot separates servers into zones for redundancy, in conjunction with the
|
2020-02-06 23:45:31 +00:00
|
|
|
[redundancy_zone](/docs/configuration/server#redundancy_zone) parameter.
|
2018-01-30 03:53:34 +00:00
|
|
|
Only one server in each zone can be a voting member at one time.
|
2017-12-18 21:16:33 +00:00
|
|
|
|
2018-01-30 03:53:34 +00:00
|
|
|
- `disable_upgrade_migration` `(bool: false)` - (Enterprise-only) Disables Autopilot's
|
|
|
|
|
upgrade migration strategy in Nomad Enterprise of waiting until enough
|
2017-12-18 21:16:33 +00:00
|
|
|
newer-versioned servers have been added to the cluster before promoting any of
|
|
|
|
|
them to voters.
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
- `enable_custom_upgrades` `(bool: false)` - (Enterprise-only) Specifies whether to
|
2018-01-30 03:53:34 +00:00
|
|
|
enable using custom upgrade versions when performing migrations, in conjunction with
|
2020-02-06 23:45:31 +00:00
|
|
|
the [upgrade_version](/docs/configuration/server#upgrade_version) parameter.
|
