Command: operator raft transfer-leadership
Transfer leadership from the current leader to the given server member.
While performing a rolling upgrade of your Nomad cluster, it might be advisable to transfer leadership to a specific node in the cluster. For example, setting the leader to the first upgraded server in the cluster can prevent leadership churn as you upgrade the remaining server nodes.
The target server's ID or address:port are required and can be obtained by
running the nomad operator raft list-peers
command or by calling the
Read Raft Configuration API endpoint.
For an API to perform these operations programmatically, please see the documentation for the Operator endpoint.
Usage
Required Permissions
If ACLs are enabled, this command requires a management token.General Options
-address=<addr>
: The address of the Nomad server. Overrides theNOMAD_ADDR
environment variable if set. Defaults tohttp://127.0.0.1:4646
.-region=<region>
: The region of the Nomad server to forward commands to. Overrides theNOMAD_REGION
environment variable if set. Defaults to the Agent's local region.-no-color
: Disables colored command output. Alternatively,NOMAD_CLI_NO_COLOR
may be set. This option takes precedence over-force-color
.-force-color
: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively,NOMAD_CLI_FORCE_COLOR
may be set. This option has no effect if-no-color
is also used.-ca-cert=<path>
: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides theNOMAD_CACERT
environment variable if set.-ca-path=<path>
: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both-ca-cert
and-ca-path
are specified,-ca-cert
is used. Overrides theNOMAD_CAPATH
environment variable if set.-client-cert=<path>
: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify-client-key
. Overrides theNOMAD_CLIENT_CERT
environment variable if set.-client-key=<path>
: Path to an unencrypted PEM encoded private key matching the client certificate from-client-cert
. Overrides theNOMAD_CLIENT_KEY
environment variable if set.-tls-server-name=<value>
: The server name to use as the SNI host when connecting via TLS. Overrides theNOMAD_TLS_SERVER_NAME
environment variable if set.-tls-skip-verify
: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped ifNOMAD_SKIP_VERIFY
is set.-token
: The SecretID of an ACL token to use to authenticate API requests with. Overrides theNOMAD_TOKEN
environment variable if set.
Transfer Leadership Options
-peer-address
: Specifies the Raft Address of the target server as provided in the output of thenomad operator raft list-peers
command or the Read Raft Configuration API endpoint.-peer-id
: Specifies the Raft ID of the target server as provided in the output of thenomad operator raft list-peers
command or the Read Raft Configuration API endpoint.Note
Either
-peer-address
or-peer-id
must be provided, but not both.