From c8bee5a934e7c12ee14b16fa1e20f5295329f05d Mon Sep 17 00:00:00 2001 From: Jono Sosulska <42216911+jsosulska@users.noreply.github.com> Date: Thu, 18 Jun 2020 14:10:45 -0400 Subject: [PATCH] Fixing multiple document updates (#8135) * Fixes #7663-ACL Token Reloadable#7432-Cipher Suites,#7385-KV Delete DC, raft list-peers docs Co-authored-by: Freddy --- website/pages/api-docs/config.mdx | 52 +++++++++++++------ website/pages/api-docs/kv.mdx | 5 ++ website/pages/docs/agent/options.mdx | 34 +++++++----- website/pages/docs/commands/operator/raft.mdx | 2 +- 4 files changed, 62 insertions(+), 31 deletions(-) diff --git a/website/pages/api-docs/config.mdx b/website/pages/api-docs/config.mdx index e667c9d247..85b63ea204 100644 --- a/website/pages/api-docs/config.mdx +++ b/website/pages/api-docs/config.mdx @@ -38,10 +38,15 @@ The table below shows this endpoint's support for 1 The ACL required depends on the config entry kind being updated:

-| Config Entry Kind | Required ACL | -| ----------------- | ---------------- | -| service-defaults | `service:write` | -| proxy-defaults | `operator:write` | +| Config Entry Kind | Required ACL | +| ----------------- | ---------------- | +| ingress-gateway | `operator:write` | +| proxy-defaults | `operator:write` | +| service-defaults | `service:write` | +| service-resolver | `service:write` | +| service-router | `service:write` | +| service-splitter | `service:write` | +| terminating-gateway | `operator:write` | ### Parameters @@ -99,10 +104,15 @@ The table below shows this endpoint's support for 1 The ACL required depends on the config entry kind being read: -| Config Entry Kind | Required ACL | -| ----------------- | -------------- | -| service-defaults | `service:read` | -| proxy-defaults | `` | +| Config Entry Kind | Required ACL | +| ----------------- | ---------------- | +| ingress-gateway | `service:read` | +| proxy-defaults | `` | +| service-defaults | `service:read` | +| service-resolver | `service:read` | +| service-router | `service:read` | +| service-splitter | `service:read` | +| terminating-gateway | `service:read` | ### Parameters @@ -161,10 +171,15 @@ The table below shows this endpoint's support for 1 The ACL required depends on the config entry kind being read: -| Config Entry Kind | Required ACL | -| ----------------- | -------------- | -| service-defaults | `service:read` | -| proxy-defaults | `` | +| Config Entry Kind | Required ACL | +| ----------------- | ---------------- | +| ingress-gateway | `service:read` | +| proxy-defaults | `` | +| service-defaults | `service:read` | +| service-resolver | `service:read` | +| service-router | `service:read` | +| service-splitter | `service:read` | +| terminating-gateway | `service:read` | ### Parameters @@ -229,10 +244,15 @@ The table below shows this endpoint's support for 1 The ACL required depends on the config entry kind being deleted: -| Config Entry Kind | Required ACL | -| ----------------- | ---------------- | -| service-defaults | `service:write` | -| proxy-defaults | `operator:write` | +| Config Entry Kind | Required ACL | +| ----------------- | ---------------- | +| ingress-gateway | `operator:write` | +| proxy-defaults | `operator:write` | +| service-defaults | `service:write` | +| service-resolver | `service:write` | +| service-router | `service:write` | +| service-splitter | `service:write` | +| terminating-gateway | `operator:write` | ### Parameters diff --git a/website/pages/api-docs/kv.mdx b/website/pages/api-docs/kv.mdx index e0c3f88b55..41885a1ff2 100644 --- a/website/pages/api-docs/kv.mdx +++ b/website/pages/api-docs/kv.mdx @@ -255,6 +255,11 @@ The table below shows this endpoint's support for ### Parameters +- `dc` `(string: "")` - Specifies the datacenter to query. This will default to + the datacenter of the agent being queried. This is specified as part of the + URL as a query parameter, and gives "No path to datacenter" error when dc is + invalid. + - `recurse` `(bool: false)` - Specifies to delete all keys which have the specified prefix. Without this, only a key with an exact match will be deleted. diff --git a/website/pages/docs/agent/options.mdx b/website/pages/docs/agent/options.mdx index 53f79b73aa..78802a9b6c 100644 --- a/website/pages/docs/agent/options.mdx +++ b/website/pages/docs/agent/options.mdx @@ -40,7 +40,9 @@ documented below in the [reload command](/docs/commands/reload) can also be used to trigger a configuration reload. -You can test the following configuration options by following the [Getting Started](https://learn.hashicorp.com/consul/getting-started/install?utm_source=consul.io&utm_medium=docs) guides to install a local agent. +You can test the following configuration options by following the +[Getting Started](https://learn.hashicorp.com/consul/getting-started/install?utm_source=consul.io&utm_medium=docs) +guides to install a local agent. ## Environment Variables @@ -1751,9 +1753,9 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'." statsite. - `prefix_filter` ((#telemetry-prefix_filter)) - This is a list of filter rules to apply for allowing/blocking metrics by prefix - in the following format: - + This is a list of filter rules to apply for allowing/blocking metrics by + prefix in the following format: + ```json ["+consul.raft.apply", "-consul.http", "+consul.http.GET"] ``` @@ -1802,9 +1804,10 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'." or "tls13". This defaults to "tls12". WARNING: TLS 1.1 and lower are generally considered less secure; avoid using these if possible. -- `tls_cipher_suites` Added in Consul 0.8.2, this - specifies the list of supported ciphersuites as a comma-separated-list. The list - of all supported ciphersuites is available in the [source code](https://github.com/hashicorp/consul/blob/master/tlsutil/config.go#L363). +- `tls_cipher_suites` Added in Consul 0.8.2, this specifies the list of + supported ciphersuites as a comma-separated-list. The list of all supported + ciphersuites is available through + [this search](https://github.com/hashicorp/consul/search?q=cipherMap+%3A%3D+map&unscoped_q=cipherMap+%3A%3D+map). - `tls_prefer_server_cipher_suites` Added in Consul 0.8.2, this will cause Consul to prefer the server's ciphersuite over the client ciphersuites. @@ -1927,14 +1930,17 @@ required ports and their default settings. Reloading configuration does not reload all configuration items. The items which are reloaded include: -- Log level +- ACL Tokens +- [Configuration Entry Bootstrap](#config_entries_bootstrap) - Checks -- Services -- Watches +- [Discard Check Output](#discard_check_output) - HTTP Client Address -- TLS Configuration - - Please be aware that this is currently limited to reload a configuration that is already TLS enabled. You cannot enable or disable TLS only with reloading. -- [Node Metadata](#node_meta) +- Log level - [Metric Prefix Filter](#telemetry-prefix_filter) -- [Discard Check Output](#discard_check_output) +- [Node Metadata](#node_meta) - [RPC rate limiting](#limits) +- [HTTP Maximum Connections per Client](#http_max_conns_per_client) +- Services +- TLS Configuration + - Please be aware that this is currently limited to reload a configuration that is already TLS enabled. You cannot enable or disable TLS only with reloading. +- Watches diff --git a/website/pages/docs/commands/operator/raft.mdx b/website/pages/docs/commands/operator/raft.mdx index c9e1c15254..619a19f753 100644 --- a/website/pages/docs/commands/operator/raft.mdx +++ b/website/pages/docs/commands/operator/raft.mdx @@ -59,7 +59,7 @@ but may be upgraded to a GUID in a future version of Consul. 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. +configuration. ## remove-peer