Skip to content

Commit

Permalink
Backport of doc(peering): missing network requirement for peering and…
Browse files Browse the repository at this point in the history
… the partiti… into release/1.13.x (#14678)

This pull request was automerged via backport-assistant
  • Loading branch information
hc-github-team-consul-core authored Sep 19, 2022
1 parent 15d9715 commit 3c321b6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions website/content/api-docs/peering.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,11 @@ The table below shows this endpoint's support for
### Path Parameters

- `name` `(string: <required>)` - Specifies the name of the peering to delete.
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peering
to delete. Uses `default` when not specified.

### Query Parameters

- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peerings
to delete. If not specified will default to `default`.

### Sample Request

Expand Down Expand Up @@ -270,6 +273,11 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | -------------- |
| `NO` | `consistent` | `none` | `peering:read` |

### Query Parameters

- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peerings
to list. If not specified will default to `default`.

### Sample Request

```shell-session
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A peering token enables cluster peering between different datacenters. Once you

## Create a peering connection

Cluster peering is not enabled by default on Consul servers. To peer clusters, you must first configure all Consul servers so that `peering` is `enabled`. For additional information, refer to [Configuration Files](/docs/agent/config/config-files).
Cluster peering is not enabled by default on Consul servers. To peer clusters, you must first configure all Consul servers so that `peering` is `enabled` and the gRPC port(8502) accepts traffic from the peering cluster (e.g., `client_addr="0.0.0.0"`). For additional information, refer to [Configuration Files](/docs/agent/config/config-files).

After enabling peering for all Consul servers, complete the following steps in order:

Expand Down

0 comments on commit 3c321b6

Please sign in to comment.