mirror of https://github.com/hashicorp/consul
Addressing docs comments
parent
f75f976006
commit
f6c7fceafa
|
@ -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.
|
||||
```
|
||||
|
|
|
@ -143,8 +143,8 @@ const (
|
|||
help = `
|
||||
Usage: consul peering exported-services [options] -name <peer 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:
|
||||
|
|
|
@ -64,7 +64,7 @@ Usage: consul peering <subcommand> [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
|
||||
|
||||
|
|
|
@ -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).
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
Loading…
Reference in New Issue