aboutsummaryrefslogtreecommitdiff
path: root/doc/book/reference-manual
diff options
context:
space:
mode:
authorRoberto Hidalgo <un@rob.mx>2023-05-15 20:02:28 -0600
committerRoberto Hidalgo <un@rob.mx>2023-05-22 08:57:15 -0600
commit2d46d24d06849584e751ffcf6842b4d3016b6f77 (patch)
tree43e91eba16526e9a83eb0afa39d100d7354c93a0 /doc/book/reference-manual
parentb7705041268e49f2a5ba9a719372048f85c3de83 (diff)
downloadgarage-2d46d24d06849584e751ffcf6842b4d3016b6f77.tar.gz
garage-2d46d24d06849584e751ffcf6842b4d3016b6f77.zip
update docs
Diffstat (limited to 'doc/book/reference-manual')
-rw-r--r--doc/book/reference-manual/configuration.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md
index 2fdfce8f..5322b755 100644
--- a/doc/book/reference-manual/configuration.md
+++ b/doc/book/reference-manual/configuration.md
@@ -322,10 +322,10 @@ reached by other nodes of the cluster, which should be set in `rpc_public_addr`.
The `consul_http_addr` parameter should be set to the full HTTP(S) address of the Consul server.
-### `consul_http_api`
+### `api`
Two APIs for service registration are supported: `catalog` and `agent`. `catalog`, the default, will register a service using
-the `/v1/catalog` endpoints and mTLS (if `client_cert` and `client_key` are provided). The `agent` API uses the
+the `/v1/catalog` endpoints, enabling mTLS if `client_cert` and `client_key` are provided. The `agent` API uses the
`v1/agent` endpoints instead, where an optional `consul_http_token` may be provided.
### `service_name`
@@ -336,7 +336,7 @@ RPC ports are announced.
### `client_cert`, `client_key`
TLS client certificate and client key to use when communicating with Consul over TLS. Both are mandatory when doing so.
-Only available when `consul_http_api = "catalog"`.
+Only available when `api = "catalog"`.
### `ca_cert`
@@ -347,9 +347,9 @@ TLS CA certificate to use when communicating with Consul over TLS.
Skip server hostname verification in TLS handshake.
`ca_cert` is ignored when this is set.
-### `consul_http_token`
+### `token`
-Uses the provided token for communication with Consul. Only available when `consul_http_api = "agent"`.
+Uses the provided token for communication with Consul. Only available when `api = "agent"`.
The policy assigned to this token should at least have these rules:
```hcl