2017-12-18 21:16:33 +00:00
|
|
|
---
|
2020-02-06 23:45:31 +00:00
|
|
|
layout: docs
|
|
|
|
page_title: 'Commands: operator autopilot set-config'
|
|
|
|
sidebar_title: autopilot set-config
|
|
|
|
description: |
|
2017-12-18 21:16:33 +00:00
|
|
|
Modify the current Autopilot configuration.
|
|
|
|
---
|
|
|
|
|
2018-03-22 20:39:18 +00:00
|
|
|
# Command: operator autopilot set-config
|
2017-12-18 21:16:33 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
The Autopilot operator command is used to set the current Autopilot
|
|
|
|
configuration. See the [Autopilot Guide] for more information about Autopilot.
|
2017-12-18 21:16:33 +00:00
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
```plaintext
|
2017-12-18 21:16:33 +00:00
|
|
|
nomad operator autopilot set-config [options]
|
|
|
|
```
|
|
|
|
|
|
|
|
## General Options
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
@include 'general_options.mdx'
|
2017-12-18 21:16:33 +00:00
|
|
|
|
|
|
|
## Set Config Options
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-cleanup-dead-servers` - Specifies whether to enable automatic removal of
|
|
|
|
dead servers upon the successful joining of new servers to the cluster. Must be
|
|
|
|
one of `[true|false]`.
|
2017-12-18 21:16:33 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-last-contact-threshold` - Controls 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 `200ms`.
|
2017-12-18 21:16:33 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-max-trailing-logs` - Controls the maximum number of log entries that a
|
|
|
|
server can trail the leader by before being considered unhealthy.
|
2017-12-18 21:16:33 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-server-stabilization-time` - Controls 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 `10s`.
|
2017-12-18 21:16:33 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-disable-upgrade-migration` - (Enterprise-only) Controls whether Nomad will
|
|
|
|
avoid promoting new servers until it can perform a migration. Must be one of
|
|
|
|
`[true|false]`.
|
2017-12-18 21:16:33 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-redundancy-zone-tag`- (Enterprise-only) Controls the [`redundancy_zone`]
|
2018-04-13 01:04:53 +00:00
|
|
|
used for separating servers into different redundancy zones.
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-upgrade-version-tag` - (Enterprise-only) Controls the [`upgrade_version`] to
|
2018-04-13 01:04:53 +00:00
|
|
|
use for version info when performing upgrade migrations. If left blank, the
|
|
|
|
Nomad version will be used.
|
2017-12-18 21:16:33 +00:00
|
|
|
|
|
|
|
The output looks like this:
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
```plaintext
|
2017-12-18 21:16:33 +00:00
|
|
|
Configuration updated!
|
|
|
|
```
|
|
|
|
|
|
|
|
The return code will indicate success or failure.
|
2019-10-22 13:44:00 +00:00
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
[`redundancy_zone`]: /docs/configuration/server#redundancy_zone
|
|
|
|
[`upgrade_version`]: /docs/configuration/server#upgrade_version
|
2020-03-20 21:00:59 +00:00
|
|
|
[autopilot guide]: https://learn.hashicorp.com/nomad/operating-nomad/autopilot
|