Struct AutopilotConfiguration

pub struct AutopilotConfiguration {
    pub disable_upgrade_migration: bool,
    pub enable_custom_upgrades: bool,
    pub create_index: u64,
    pub modify_index: u64,
    pub cleanup_dead_servers: bool,
    pub server_stabilization_time: TimeDelta,
    pub enable_redundancy_zones: bool,
    pub last_contact_threshold: TimeDelta,
    pub max_trailing_logs: u64,
    pub min_quorum: u64,
}

AutopilotConfiguration is used for querying/setting the Autopilot configuration. Autopilot helps manage operator tasks related to Nomad servers like removing failed servers from the Raft quorum.

This struct was generated based on the Go types of the official Nomad API.

Fields

disable_upgrade_migration: bool

(Enterprise-only) DisableUpgradeMigration will disable Autopilot’s upgrade migration strategy of waiting until enough newer-versioned servers have been added to the cluster before promoting them to voters.

enable_custom_upgrades: bool

(Enterprise-only) EnableCustomUpgrades specifies whether to enable using custom upgrade versions when performing migrations.

create_index: u64

CreateIndex holds the index corresponding the creation of this configuration. This is a read-only field.

modify_index: u64

ModifyIndex will be set to the index of the last update when retrieving the Autopilot configuration. Resubmitting a configuration with AutopilotCASConfiguration will perform a check-and-set operation which ensures there hasn’t been a subsequent update since the configuration was retrieved.

cleanup_dead_servers: bool

CleanupDeadServers controls whether to remove dead servers from the Raft peer list when a new server joins

server_stabilization_time: TimeDelta

ServerStabilizationTime is the minimum amount of time a server must be in a stable, healthy state before it can be added to the cluster. Only applicable with Raft protocol version 3 or higher.

enable_redundancy_zones: bool

(Enterprise-only) EnableRedundancyZones specifies whether to enable redundancy zones.

last_contact_threshold: TimeDelta

LastContactThreshold is the limit on the amount of time a server can go without leader contact before being considered unhealthy.

max_trailing_logs: u64

MaxTrailingLogs is the amount of entries in the Raft Log that a server can be behind before being considered unhealthy.

min_quorum: u64

MinQuorum sets the minimum number of servers allowed in a cluster before autopilot can prune dead servers.

Trait Implementations

impl Clone for AutopilotConfiguration

fn clone(&self) -> AutopilotConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AutopilotConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AutopilotConfiguration

fn default() -> AutopilotConfiguration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AutopilotConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AutopilotConfiguration

fn eq(&self, other: &AutopilotConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AutopilotConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AutopilotConfiguration