From 583850e9d4b6c2a9ce94b295ebbd518d712aa5ce Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Tue, 4 May 2021 17:32:07 -0400 Subject: [PATCH] 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. --- website/content/api-docs/config.mdx | 6 ++++-- website/content/commands/config/delete.mdx | 4 +++- website/content/commands/config/list.mdx | 2 +- website/content/commands/config/read.mdx | 4 +++- website/content/docs/connect/config-entries/index.mdx | 6 +++--- website/content/docs/connect/config-entries/mesh.mdx | 4 ---- 6 files changed, 14 insertions(+), 12 deletions(-) diff --git a/website/content/api-docs/config.mdx b/website/content/api-docs/config.mdx index 96d73f7259..5b1ae0dab3 100644 --- a/website/content/api-docs/config.mdx +++ b/website/content/api-docs/config.mdx @@ -125,7 +125,8 @@ The table below shows this endpoint's support for is specified as part of the URL. - `name` `(string: )` - 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: "")` - 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: )` - 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: "")` - Specifies the namespace to delete from. This value may be provided by either the `ns` URL query parameter or in the diff --git a/website/content/commands/config/delete.mdx b/website/content/commands/config/delete.mdx index d500d526e2..acfc81ce21 100644 --- a/website/content/commands/config/delete.mdx +++ b/website/content/commands/config/delete.mdx @@ -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 read. The name of the + `proxy-defaults` config entry must be `global`, and the name of the `mesh` + config entry must be `mesh`. ## Examples diff --git a/website/content/commands/config/list.mdx b/website/content/commands/config/list.mdx index 0b7245f193..b65d50ea04 100644 --- a/website/content/commands/config/list.mdx +++ b/website/content/commands/config/list.mdx @@ -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 diff --git a/website/content/commands/config/read.mdx b/website/content/commands/config/read.mdx index cbc7aae7f2..76ef8b92cd 100644 --- a/website/content/commands/config/read.mdx +++ b/website/content/commands/config/read.mdx @@ -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 diff --git a/website/content/docs/connect/config-entries/index.mdx b/website/content/docs/connect/config-entries/index.mdx index 92e5dc463b..4551fefba7 100644 --- a/website/content/docs/connect/config-entries/index.mdx +++ b/website/content/docs/connect/config-entries/index.mdx @@ -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) Beta - 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) Beta - controls + mesh-wide configuration that applies across namespaces and federated datacenters. + - [Proxy Defaults](/docs/connect/config-entries/proxy-defaults) - controls proxy configuration diff --git a/website/content/docs/connect/config-entries/mesh.mdx b/website/content/docs/connect/config-entries/mesh.mdx index 538134d8d6..932f78ada9 100644 --- a/website/content/docs/connect/config-entries/mesh.mdx +++ b/website/content/docs/connect/config-entries/mesh.mdx @@ -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: )` - Must be set to `mesh` - - `Namespace` `(string: "default")` - Specifies the namespace the config entry will apply to. Must be set to `default`