diff --git a/.changelog/19821.txt b/.changelog/19821.txt index c7f418a1cc..ee88046faa 100644 --- a/.changelog/19821.txt +++ b/.changelog/19821.txt @@ -1,3 +1,3 @@ ```release-note:feature -cli: Adds new subcommand `peering exported-service` to list exported services to a peer . Refer to the [CLI docs](https://www.consul.io/commands/peering) for more information. +cli: Adds new subcommand `peering exported-services` to list services exported to a peer . Refer to the [CLI docs](https://developer.hashicorp.com/consul/commands/peering) for more information. ``` diff --git a/command/peering/exportedservices/exported_services.go b/command/peering/exportedservices/exported_services.go index de1d5210bd..d075257b33 100644 --- a/command/peering/exportedservices/exported_services.go +++ b/command/peering/exportedservices/exported_services.go @@ -143,8 +143,8 @@ const ( help = ` Usage: consul peering exported-services [options] -name - Lists exported services to the provided peer name. If peer is not found, - the command will exit with a non-zero code. The result will be filtered according + Lists services exported to the peer with the provided name. If the peer is not found, + the command exits with a non-zero code. The result is filtered according to ACL policy configuration. Example: diff --git a/command/peering/peering.go b/command/peering/peering.go index 52cc1ec73d..9c520b3d6f 100644 --- a/command/peering/peering.go +++ b/command/peering/peering.go @@ -64,7 +64,7 @@ Usage: consul peering [options] [args] $ consul peering read -name west-dc - Lists exported services to a peering connection: + Lists services exported to a peering connection: $ consul peering exported-services -name west-dc diff --git a/website/content/commands/peering/exported-services.mdx b/website/content/commands/peering/exported-services.mdx index 9918bcdd59..316b6daf21 100644 --- a/website/content/commands/peering/exported-services.mdx +++ b/website/content/commands/peering/exported-services.mdx @@ -2,7 +2,7 @@ layout: commands page_title: 'Commands: Peering Exported Services' description: | - The `consul peering exported-services` command outputs the exported services to a given peer. + The `consul peering exported-services` command outputs a list of services exported to a cluster peer. --- # Consul Peering Exported Services @@ -11,7 +11,7 @@ Command: `consul peering exported-services` Corresponding HTTP API Endpoint: [\[GET\] /v1/peering/:name](/consul/api-docs/peering#read-a-peering-connection) -The `peering exported-services` displays all the exported services to the peer. +The `peering exported-services` command displays all of the services that were exported to the cluster peer using an [`exported-services` configuration entry](/consul/docs/connect/config-entries/exported-services). The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication). diff --git a/website/content/commands/peering/index.mdx b/website/content/commands/peering/index.mdx index 50ff3972a7..62af45d22b 100644 --- a/website/content/commands/peering/index.mdx +++ b/website/content/commands/peering/index.mdx @@ -24,10 +24,10 @@ Subcommands: delete Close and delete a peering connection establish Consume a peering token and establish a connection with the accepting cluster + exported-services Lists the services exported to the peer generate-token Generate a peering token for use by a dialing cluster list List the local cluster's peering connections read Read detailed information on a peering connection - exported-services Lists the exported services to the peer ``` For more information, examples, and usage about a subcommand, click on the name diff --git a/website/data/commands-nav-data.json b/website/data/commands-nav-data.json index 2cf41daf21..1b0cadd044 100644 --- a/website/data/commands-nav-data.json +++ b/website/data/commands-nav-data.json @@ -472,6 +472,10 @@ "title": "establish", "path": "peering/establish" }, + { + "title": "exported-services", + "path": "peering/exported-services" + }, { "title": "generate-token", "path": "peering/generate-token" @@ -483,10 +487,6 @@ { "title": "read", "path": "peering/read" - }, - { - "title": "exported-services", - "path": "peering/exported-services" } ] },