Merge pull request #10177 from hashicorp/dnephin/config-entry-remove-fields
docs: remove name field from Mesh config entry
This commit is contained in:
commit
c7d1a6a080
|
@ -204,6 +204,7 @@ func TestAPI_ConfigEntries(t *testing.T) {
|
|||
"foo": "bar",
|
||||
"gir": "zim",
|
||||
},
|
||||
Namespace: defaultNamespace,
|
||||
}
|
||||
ce := c.ConfigEntries()
|
||||
|
||||
|
|
|
@ -125,7 +125,8 @@ The table below shows this endpoint's support for
|
|||
is specified as part of the URL.
|
||||
|
||||
- `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.
|
||||
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.
|
||||
|
||||
- `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.
|
||||
This value may be provided by either the `ns` URL query parameter or in the
|
||||
|
|
|
@ -27,7 +27,9 @@ Usage: `consul config delete [options]`
|
|||
|
||||
- `-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 delete. The name of the
|
||||
`proxy-defaults` config entry must be `global`, and the name of the `mesh`
|
||||
config entry must be `mesh`.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
@ -25,7 +25,7 @@ Usage: `consul 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
|
||||
|
||||
|
|
|
@ -28,7 +28,9 @@ Usage: `consul config read [options]`
|
|||
|
||||
- `-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
|
||||
|
||||
|
|
|
@ -12,12 +12,12 @@ Configuration entries can be used to configure the behavior of Consul Connect.
|
|||
|
||||
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
|
||||
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 configuration
|
||||
|
||||
|
|
|
@ -25,7 +25,6 @@ Settings in this config entry apply across all namespaces and federated datacent
|
|||
|
||||
```hcl
|
||||
Kind = "mesh"
|
||||
Name = "mesh"
|
||||
|
||||
TransparentProxy {
|
||||
CatalogDestinationsOnly = true
|
||||
|
@ -40,7 +39,6 @@ namespace and it will apply to proxies across **all** namespaces.
|
|||
|
||||
```hcl
|
||||
Kind = "mesh"
|
||||
Name = "mesh"
|
||||
Namespace = "default" # Can only be set to "default".
|
||||
|
||||
TransparentProxy {
|
||||
|
@ -55,8 +53,6 @@ TransparentProxy {
|
|||
|
||||
- `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.
|
||||
Must be set to `default`
|
||||
|
||||
|
|
Loading…
Reference in New Issue