From 52656f442611c4ef8b6c791baac27bd08c1b7f51 Mon Sep 17 00:00:00 2001 From: boruszak Date: Mon, 1 Aug 2022 14:43:10 -0500 Subject: [PATCH] Proofing updates & adjustments --- .../cluster-peering/create-manage-peering.mdx | 13 ++++++++----- .../content/docs/connect/cluster-peering/index.mdx | 4 ++-- .../content/docs/connect/cluster-peering/k8s.mdx | 2 +- 3 files changed, 11 insertions(+), 8 deletions(-) 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 9438c6ec2..c0631f2dc 100644 --- a/website/content/docs/connect/cluster-peering/create-manage-peering.mdx +++ b/website/content/docs/connect/cluster-peering/create-manage-peering.mdx @@ -17,7 +17,7 @@ To peer clusters, you must complete the following steps in order: 1. Create a peering token 1. Establish a connection between clusters -1. Export services +1. Export services between clusters 1. Authorize services for peers ### Create a peering token @@ -28,7 +28,7 @@ To begin the cluster peering process, generate a peering token in one of your cl -In `cluster-01`, issue a request for a peering token using the [HTTP API](/api-docs/peering). +In `cluster-01`, issue a request for a peering token. ```shell-session $ curl --request POST --data '{"PeerName":"cluster-02"}' --url http://localhost:8500/v1/peering/token @@ -74,7 +74,8 @@ When you connect server agents through cluster peering, they peer their default -### Export services + +### Export services between clusters After you establish a connection between the clusters, you need to create a configuration entry that defines the services that are available for other clusters. Consul uses this configuration entry to advertise service information and support service mesh connections across clusters. @@ -160,9 +161,11 @@ $ consul config write peering-intentions.hcl ## Manage peering connections +After you establish a peering connection, you can get a list of all active peering connections, read a specific peering connection's info, check peering connection health, and delete peering connections. + ### List all peering connections -After you establish a peering connection, you can get a list of all active peering connections. +You can list all active peering connections in a cluster. @@ -265,7 +268,7 @@ After you create a peering connection between clusters in different datacenters, -In "cluster-01," request the deletion via the HTTP API. +In "cluster-01," request the deletion through the [`/peering/` endpoint](api-docs/peering#delete-a-peering-connection). ```shell-session $ curl --request DELETE http://127.0.0.1:8500/v1/peering/cluster-02 diff --git a/website/content/docs/connect/cluster-peering/index.mdx b/website/content/docs/connect/cluster-peering/index.mdx index 7eaa06fdc..a50dd2699 100644 --- a/website/content/docs/connect/cluster-peering/index.mdx +++ b/website/content/docs/connect/cluster-peering/index.mdx @@ -17,9 +17,9 @@ Cluster peering allows Consul clusters in different datacenters to communicate w 1. Create a peering token in one cluster. 1. Use the peering token to establish peering with a second cluster. 1. Export services between clusters. -1. Create intentions to set up service mesh between clusters. +1. Create intentions to authorize services for peers. -For detailed instructions on setting up cluster peering with the Consul CLI, refer to [Create and Manage Peering Connections](/docs/connect/cluster-peering/create-manage-peering). +For detailed instructions on setting up cluster peering, refer to [Create and Manage Peering Connections](/docs/connect/cluster-peering/create-manage-peering). ### Differences between WAN federation and cluster peering diff --git a/website/content/docs/connect/cluster-peering/k8s.mdx b/website/content/docs/connect/cluster-peering/k8s.mdx index c704c7876..8d3c510f8 100644 --- a/website/content/docs/connect/cluster-peering/k8s.mdx +++ b/website/content/docs/connect/cluster-peering/k8s.mdx @@ -21,7 +21,7 @@ The following Custom Resource Definitions (CRDs) are used to create and manage a ## Prerequisites You must implement the following requirements to create and use cluster peering connections with Kubernetes: -- Consul v1.13 or later +- Consul v1.13.0 or later - At least two Kubernetes clusters - The Kubernetes clusters must be running in a flat network - The network must be running on Consul on Kubernetes v0.45 or later