From 5b2d557db1be29dd2c952260c1df2492d20b2f15 Mon Sep 17 00:00:00 2001 From: cskh Date: Mon, 19 Sep 2022 16:11:04 -0400 Subject: [PATCH] =?UTF-8?q?doc(peering):=20missing=20network=20requirement?= =?UTF-8?q?=20for=20peering=20and=20the=20partiti=E2=80=A6=20(#14677)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * doc(peering): missing network requirement for peering and the partition parameter in the list API * Delete API: move partition from path parameter to query parameter --- website/content/api-docs/peering.mdx | 12 ++++++++++-- .../cluster-peering/create-manage-peering.mdx | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/website/content/api-docs/peering.mdx b/website/content/api-docs/peering.mdx index 77a7bb2e2..dfae8837b 100644 --- a/website/content/api-docs/peering.mdx +++ b/website/content/api-docs/peering.mdx @@ -221,8 +221,11 @@ The table below shows this endpoint's support for ### Path Parameters - `name` `(string: )` - Specifies the name of the peering to delete. -- `partition` `(string: "")` - Specifies the partition of the peering - to delete. Uses `default` when not specified. + +### Query Parameters + +- `partition` `(string: "")` - Specifies the partition of the peerings + to delete. If not specified will default to `default`. ### Sample Request @@ -270,6 +273,11 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | -------------- | | `NO` | `consistent` | `none` | `peering:read` | +### Query Parameters + +- `partition` `(string: "")` - Specifies the partition of the peerings + to list. If not specified will default to `default`. + ### Sample Request ```shell-session diff --git a/website/content/docs/connect/cluster-peering/create-manage-peering.mdx b/website/content/docs/connect/cluster-peering/create-manage-peering.mdx index 56a0ee2ef..916ef33da 100644 --- a/website/content/docs/connect/cluster-peering/create-manage-peering.mdx +++ b/website/content/docs/connect/cluster-peering/create-manage-peering.mdx @@ -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: