luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

Doc: Raft retry join (#8448) 

* Doc: Raft retry join

* Update website/pages/docs/configuration/storage/raft.mdx

Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com>

* Update website/pages/docs/configuration/storage/raft.mdx

Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com>

* Update website/pages/docs/configuration/storage/raft.mdx

Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com>

* Update website/pages/docs/configuration/storage/raft.mdx

Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com>

* Address review feedback

Co-authored-by: Brian Kassouf <briankassouf@users.noreply.github.com>
This commit is contained in:
Brian Kassouf 2020-03-05 16:47:10 -08:00 committed by GitHub
parent 2103d61131
commit d71584a64d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
website/pages/docs/configuration/storage/raft.mdx
View File

@ -85,4 +85,50 @@ set `ha_enabled = true`.
snapshot. Servers may take longer to recover from crashes or failover if this
is increased significantly as more logs will need to be replayed.
- `retry_join` `(list: [])` - There can be one or more `retry_join` stanzas.
When the raft cluster is getting bootstrapped, if the connection details of all
the nodes are known beforehand, then specifying this config stanzas enables the
nodes to automatically join a raft cluster. All the nodes would mention all
other nodes that they could join using this config. When one of the nodes is
initialized, it becomes the leader and all the other nodes will join the
leader node to form the cluster. When using Shamir seal, the joined nodes will
still need to be unsealed manually. See the section below that describes the
parameters accepted by the `retry_join` stanza.
### `retry_join` stanza
- `leader_api_addr` `(string: "")` - Address of a possible leader node
- `leader_ca_cert` `(string: "")` - CA cert of the possible leader node
- `leader_client_cert` `(string: "")` - Client certificate for the follower node to establish client authentication with the possible leader node
- `leader_client_key` `(string: "")` - Client key for the follower node to establish client authentication with the possible leader node
Example Configuration:
```
storage "raft" {
path = "/Users/foo/raft/"
node_id = "node1"
retry_join {
leader_api_addr = "http://127.0.0.2:8200"
leader_ca_cert = "/path/to/ca1"
leader_client_cert = "/path/to/client/cert1"
leader_client_key = "/path/to/client/key1"
}
retry_join {
leader_api_addr = "http://127.0.0.3:8200"
leader_ca_cert = "/path/to/ca2"
leader_client_cert = "/path/to/client/cert2"
leader_client_key = "/path/to/client/key2"
}
retry_join {
leader_api_addr = "http://127.0.0.4:8200"
leader_ca_cert = "/path/to/ca3"
leader_client_cert = "/path/to/client/cert3"
leader_client_key = "/path/to/client/key3"
}
}
```
[raft]: https://raft.github.io/ 'The Raft Consensus Algorithm'