Skip to content

Commit b2fcecb

Browse files
committed
docs: update raft docs with new file-based TLS params
1 parent 2aac2c3 commit b2fcecb

File tree

1 file changed

+29
-13
lines changed
  • website/pages/docs/configuration/storage

1 file changed

+29
-13
lines changed

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

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,29 @@ time. To use Raft for HA coordination users must also use Raft for storage.
9696

9797
### `retry_join` stanza
9898

99-
- `leader_api_addr` `(string: "")` - Address of a possible leader node
99+
- `leader_api_addr` `(string: "")` - Address of a possible leader node.
100100

101-
- `leader_ca_cert` `(string: "")` - CA cert of the possible leader node
101+
- `leader_ca_cert_file` `(string: "")` - File path to the CA cert of the
102+
possible leader node.
102103

103-
- `leader_client_cert` `(string: "")` - Client certificate for the follower node to establish client authentication with the possible leader node
104+
- `leader_client_cert_file` `(string: "")` -File path to the client certificate
105+
for the follower node to establish client authentication with the possible
106+
leader node.
104107

105-
- `leader_client_key` `(string: "")` - Client key for the follower node to establish client authentication with the possible leader node
108+
- `leader_client_key_file` `(string: "")` - File path to the client key for the
109+
follower node to establish client authentication with the possible leader node.
110+
111+
- `leader_ca_cert` `(string: "")` - CA cert of the possible leader node.
112+
113+
- `leader_client_cert` `(string: "")` - Client certificate for the follower node
114+
to establish client authentication with the possible leader node.
115+
116+
- `leader_client_key` `(string: "")` - Client key for the follower node to
117+
establish client authentication with the possible leader node.
118+
119+
Each `retry_join` block may provide TLS certificates via file paths or as a
120+
single-line certificate string value with newlines delimited by `\n`, but not a
121+
combination of both.
106122

107123
Example Configuration:
108124
```
@@ -111,21 +127,21 @@ storage "raft" {
111127
node_id = "node1"
112128
retry_join {
113129
leader_api_addr = "http://127.0.0.2:8200"
114-
leader_ca_cert = "/path/to/ca1"
115-
leader_client_cert = "/path/to/client/cert1"
116-
leader_client_key = "/path/to/client/key1"
130+
leader_ca_cer_file = "/path/to/ca1"
131+
leader_client_cert_file = "/path/to/client/cert1"
132+
leader_client_key_file = "/path/to/client/key1"
117133
}
118134
retry_join {
119135
leader_api_addr = "http://127.0.0.3:8200"
120-
leader_ca_cert = "/path/to/ca2"
121-
leader_client_cert = "/path/to/client/cert2"
122-
leader_client_key = "/path/to/client/key2"
136+
leader_ca_cert_file = "/path/to/ca2"
137+
leader_client_cert_file = "/path/to/client/cert2"
138+
leader_client_key_file = "/path/to/client/key2"
123139
}
124140
retry_join {
125141
leader_api_addr = "http://127.0.0.4:8200"
126-
leader_ca_cert = "/path/to/ca3"
127-
leader_client_cert = "/path/to/client/cert3"
128-
leader_client_key = "/path/to/client/key3"
142+
leader_ca_cert_file = "/path/to/ca3"
143+
leader_client_cert_file = "/path/to/client/cert3"
144+
leader_client_key_file = "/path/to/client/key3"
129145
}
130146
}
131147
```

0 commit comments

Comments
 (0)