luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Condense raft subcommand into one doc page

This commit is contained in:
Kyle Havlovitz 2017-02-16 11:44:14 -08:00
parent 2b12a43840
commit 3f05576cc8
No known key found for this signature in database
GPG Key ID: 8A5E6B173056AD6C
6 changed files with 58 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
command/operator_raft.go
View File

@ -61,6 +61,8 @@ func (c *OperatorRaftCommand) raft(args []string) error {
f.StringVar(&address, "address", "",
"The address to remove from the Raft configuration.")
// Leave these flags for backwards compatibility, but hide them
// TODO: remove flags/behavior from this command in Consul 0.9
c.Command.HideFlags("list-peers", "remove-peer", "address")
if err := c.Command.Parse(args); err != nil {

2
command/operator_raft_remove.go
View File

@ -17,7 +17,7 @@ func (c *OperatorRaftRemoveCommand) Help() string {
helpText := `
Usage: consul operator raft remove-peer [options]
Remove the Consul server with given -peer-address from the Raft configuration.
Remove the Consul server with given -address from the Raft configuration.
There are rare cases where a peer may be left behind in the Raft quorum even
though the server is no longer present and known to the cluster. This command

61
website/source/docs/commands/operator/raft.html.markdown.erb
View File

@ -14,12 +14,12 @@ The Raft operator command is used to interact with Consul's Raft subsystem. The
command can be used to verify Raft peers or in rare cases to recover quorum by
removing invalid peers.
## Usage
```text
Usage: consul operator raft <subcommand> [options]
# ...
The Raft operator command is used to interact with Consul's Raft subsystem. The
command can be used to verify Raft peers or in rare cases to recover quorum by
removing invalid peers.
Subcommands:
@ -27,8 +27,55 @@ Subcommands:
remove-peer Remove a Consul server from the Raft configuration
```
For more information, examples, and usage about a subcommand, click on the name
of the subcommand in the sidebar or one of the links below:
## list-peers
- [list-peers] (/docs/commands/operator/raft/list-peers.html)
- [remove-peer] (/docs/commands/operator/raft/remove-peer.html)
This command displays the current Raft peer configuration.
Usage: `consul operator raft list-peers -stale=[true|false]`
* `-stale` - Optional and defaults to "false" which means the leader provides
the result. If the cluster is in an outage state without a leader, you may need
to set this to "true" to get the configuration from a non-leader server.
The output looks like this:
```
Node ID Address State Voter
alice 127.0.0.1:8300 127.0.0.1:8300 follower true
bob 127.0.0.2:8300 127.0.0.2:8300 leader true
carol 127.0.0.3:8300 127.0.0.3:8300 follower true
```
`Node` is the node name of the server, as known to Consul, or "(unknown)" if
the node is stale and not known.
`ID` is the ID of the server. This is the same as the `Address` in Consul 0.7
but may be upgraded to a GUID in a future version of Consul.
`Address` is the IP:port for the server.
`State` is either "follower" or "leader" depending on the server's role in the
Raft configuration.
`Voter` is "true" or "false", indicating if the server has a vote in the Raft
configuration. Future versions of Consul may add support for non-voting servers.
## remove-peer
This command removes the Consul server with given address from the Raft configuration.
There are rare cases where a peer may be left behind in the Raft configuration
even though the server is no longer present and known to the cluster. This command
can be used to remove the failed server so that it is no longer affects the
Raft quorum. If the server still shows in the output of the
[`consul members`](/docs/commands/members.html) command, it is preferable to
clean up by simply running
[`consul force-leave`](/docs/commands/force-leave.html)
instead of this command.
Usage: `consul operator raft remove-peer -address="IP:port"`
* `-address` - "IP:port" for the server to remove. The port number is usually
8300, unless configured otherwise.
The return code will indicate success or failure.

42
website/source/docs/commands/operator/raft/list-peers.html.markdown.erb
View File

@ -1,42 +0,0 @@
---
layout: "docs"
page_title: "Commands: Operator Raft List-Peers"
sidebar_current: "docs-commands-operator-raft-list-peers"
description: >
The operator command provides cluster-level tools for Consul operators.
---
# Operator Raft List-Peers
Command: `consul operator raft list-peers`
This action displays the current Raft peer configuration.
Usage: `consul operator raft list-peers -stale=[true|false]`
* `-stale` - Optional and defaults to "false" which means the leader provides
the result. If the cluster is in an outage state without a leader, you may need
to set this to "true" to get the configuration from a non-leader server.
The output looks like this:
```
Node ID Address State Voter
alice 127.0.0.1:8300 127.0.0.1:8300 follower true
bob 127.0.0.2:8300 127.0.0.2:8300 leader true
carol 127.0.0.3:8300 127.0.0.3:8300 follower true
```
`Node` is the node name of the server, as known to Consul, or "(unknown)" if
the node is stale and not known.
`ID` is the ID of the server. This is the same as the `Address` in Consul 0.7
but may be upgraded to a GUID in a future version of Consul.
`Address` is the IP:port for the server.
`State` is either "follower" or "leader" depending on the server's role in the
Raft configuration.
`Voter` is "true" or "false", indicating if the server has a vote in the Raft
configuration. Future versions of Consul may add support for non-voting servers.

29
website/source/docs/commands/operator/raft/remove-peer.html.markdown.erb
View File

@ -1,29 +0,0 @@
---
layout: "docs"
page_title: "Commands: Operator Raft Remove-Peer"
sidebar_current: "docs-commands-operator-raft-remove-peer"
description: >
The operator command provides cluster-level tools for Consul operators.
---
# Operator Raft Remove-Peer
Command: `consul operator raft remove-peer`
This command removes the Consul server with given address from the Raft configuration.
There are rare cases where a peer may be left behind in the Raft configuration
even though the server is no longer present and known to the cluster. This command
can be used to remove the failed server so that it is no longer affects the
Raft quorum. If the server still shows in the output of the
[`consul members`](/docs/commands/members.html) command, it is preferable to
clean up by simply running
[`consul force-leave`](/docs/commands/force-leave.html)
instead of this command.
Usage: `consul operator raft remove-peer -address="IP:port"`
* `-address` - "IP:port" for the server to remove. The port number is usually
8300, unless configured otherwise.
The return code will indicate success or failure.

10
website/source/layouts/docs.erb
View File

@ -143,15 +143,7 @@
<a href="/docs/commands/operator.html">operator</a>
<ul class="subnav">
<li<%= sidebar_current("docs-commands-operator-raft") %>>
<a href="/docs/commands/operator/raft.html">raft</a>
<ul class="subnav">
<li<%= sidebar_current("docs-commands-operator-raft-list-peers") %>>
<a href="/docs/commands/operator/raft/list-peers.html">list-peers</a>
</li>
<li<%= sidebar_current("docs-commands-operator-raft-remove-peer") %>>
<a href="/docs/commands/operator/raft/remove-peer.html">remove-peer</a>
</li>
</ul>
<a href="/docs/commands/operator/raft.html">raft</a>
</li>
</ul>
</li>