docs: remove name field from Mesh config entry

Also document the name of these config entries in the API docs, so that
users know how to query for them.

And fix the name of mesh on the index page.
This commit is contained in:
Daniel Nephin 2021-05-04 17:32:07 -04:00
parent f5afed82c8
commit 583850e9d4
6 changed files with 14 additions and 12 deletions

View File

@ -125,7 +125,8 @@ The table below shows this endpoint's support for
is specified as part of the URL. is specified as part of the URL.
- `name` `(string: <required>)` - Specifies the name of the entry to read. This - `name` `(string: <required>)` - Specifies the name of the entry to read. This
is specified as part of the URL. is specified as part of the URL. The name of the `proxy-defaults` config entry
must be `global`, and the name of the `mesh` config entry must be `mesh`.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
This value may be provided by either the `ns` URL query parameter or in the This value may be provided by either the `ns` URL query parameter or in the
@ -267,7 +268,8 @@ The table below shows this endpoint's support for
is specified as part of the URL. is specified as part of the URL.
- `name` `(string: <required>)` - Specifies the name of the entry to delete. This - `name` `(string: <required>)` - Specifies the name of the entry to delete. This
is specified as part of the URL. is specified as part of the URL. The name of the `proxy-defaults` config entry
must be `global`, and the name of the `mesh` config entry must be `mesh`.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to delete from. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to delete from.
This value may be provided by either the `ns` URL query parameter or in the This value may be provided by either the `ns` URL query parameter or in the

View File

@ -27,7 +27,9 @@ Usage: `consul config delete [options]`
- `-kind` - Specifies the kind of the config entry to read. - `-kind` - Specifies the kind of the config entry to read.
- `-name` - Specifies the name of the config entry to read. - `-name` - Specifies the name of the config entry to read. The name of the
`proxy-defaults` config entry must be `global`, and the name of the `mesh`
config entry must be `mesh`.
## Examples ## Examples

View File

@ -25,7 +25,7 @@ Usage: `consul config list [options]`
#### Config List Options #### Config List Options
- `-kind` - Specifies the kind of the config entry to read. - `-kind` - Specifies the kind of the config entry to list.
## Examples ## Examples

View File

@ -28,7 +28,9 @@ Usage: `consul config read [options]`
- `-kind` - Specifies the kind of the config entry to read. - `-kind` - Specifies the kind of the config entry to read.
- `-name` - Specifies the name of the config entry to read. - `-name` - Specifies the name of the config entry to read. The name of the
`proxy-defaults` config entry must be `global`, and the name of the `mesh`
config entry must be `mesh`.
## Examples ## Examples

View File

@ -12,12 +12,12 @@ Configuration entries can be used to configure the behavior of Consul Connect.
The following configuration entries are supported: The following configuration entries are supported:
- [Cluster](/docs/connect/config-entries/cluster) <sup>Beta</sup> - controls
cluster-wide configuration that applies across namespaces and federated datacenters.
- [Ingress Gateway](/docs/connect/config-entries/ingress-gateway) - defines the - [Ingress Gateway](/docs/connect/config-entries/ingress-gateway) - defines the
configuration for an ingress gateway configuration for an ingress gateway
- [Mesh](/docs/connect/config-entries/mesh) <sup>Beta</sup> - controls
mesh-wide configuration that applies across namespaces and federated datacenters.
- [Proxy Defaults](/docs/connect/config-entries/proxy-defaults) - controls - [Proxy Defaults](/docs/connect/config-entries/proxy-defaults) - controls
proxy configuration proxy configuration

View File

@ -25,7 +25,6 @@ Settings in this config entry apply across all namespaces and federated datacent
```hcl ```hcl
Kind = "mesh" Kind = "mesh"
Name = "mesh"
TransparentProxy { TransparentProxy {
CatalogDestinationsOnly = true CatalogDestinationsOnly = true
@ -40,7 +39,6 @@ namespace and it will apply to proxies across **all** namespaces.
```hcl ```hcl
Kind = "mesh" Kind = "mesh"
Name = "mesh"
Namespace = "default" # Can only be set to "default". Namespace = "default" # Can only be set to "default".
TransparentProxy { TransparentProxy {
@ -55,8 +53,6 @@ TransparentProxy {
- `Kind` - Must be set to `mesh` - `Kind` - Must be set to `mesh`
- `Name` `(string: <required>)` - Must be set to `mesh`
- `Namespace` `(string: "default")` <EnterpriseAlert inline /> - Specifies the namespace the config entry will apply to. - `Namespace` `(string: "default")` <EnterpriseAlert inline /> - Specifies the namespace the config entry will apply to.
Must be set to `default` Must be set to `default`