From 8a02c062569c9140f6fa0a5ae19d73dd16881cc2 Mon Sep 17 00:00:00 2001 From: boruszak Date: Wed, 18 Jan 2023 15:42:34 -0600 Subject: [PATCH] Small fixes/updates --- .../docs/connect/cluster-peering/configuration.mdx | 6 +++--- .../content/docs/connect/cluster-peering/index.mdx | 1 + .../usage/create-cluster-peering.mdx | 2 +- .../docs/connect/cluster-peering/usage/k8s.mdx | 13 ++++++------- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/website/content/docs/connect/cluster-peering/configuration.mdx b/website/content/docs/connect/cluster-peering/configuration.mdx index 53fab696c0c2..918ed586ab54 100644 --- a/website/content/docs/connect/cluster-peering/configuration.mdx +++ b/website/content/docs/connect/cluster-peering/configuration.mdx @@ -5,15 +5,15 @@ description: >- --- -# Enabling Service-to-service Traffic Across Peered Clusters +# Cluster Peering Configuration -The topic provides an overview of the configuration options and process for cluster peering. +This topic provides an overview of the configuration options when creating cluster peering. Use these options to enable service-to-service traffic Across Peered Clusters ## Prerequisites To configure mesh gateways for cluster peering, make sure your Consul environment meets the following requirements: -- Consul version 1.14.0 or newer. +- Consul v1.14 or higher. - A local Consul agent is required to manage mesh gateway configuration. - Use [Envoy proxies](/docs/connect/proxies/envoy). Envoy is the only proxy with mesh gateway capabilities in Consul. diff --git a/website/content/docs/connect/cluster-peering/index.mdx b/website/content/docs/connect/cluster-peering/index.mdx index 4bcc5de237d3..d8bb568b8a34 100644 --- a/website/content/docs/connect/cluster-peering/index.mdx +++ b/website/content/docs/connect/cluster-peering/index.mdx @@ -29,6 +29,7 @@ You can find specific cluster peering configuration and usage information in the - To manage or delete existing cluster peering connections, refer to [Manage cluster peering connections](/consul/docs/cluster-peering/usage/manage-connections). - To set up service failovers and redirects, refer to [L7 traffic management for cluster peering connections](/consul/docs/cluster-peering/usage/peering-traffic-management). - To use cluster peering with Kubernetes deployments, refer to [Cluster peering on Kubernetes](/consul/docs/cluster-peering/usage/k8s). +- To use cluster peering with HCP Consul, refer to [Cluster peering in the HCP documentation](/hcp/docs/consul/usage/cluster-peering). > To learn how to peer clusters and connect services across peers in AWS Elastic Kubernetes Service (EKS) environments, complete the [Consul Cluster Peering on Kubernetes tutorial](/consul/tutorials/developer-mesh/cluster-peering-aws). diff --git a/website/content/docs/connect/cluster-peering/usage/create-cluster-peering.mdx b/website/content/docs/connect/cluster-peering/usage/create-cluster-peering.mdx index 1bbf78b16340..557b83864cb9 100644 --- a/website/content/docs/connect/cluster-peering/usage/create-cluster-peering.mdx +++ b/website/content/docs/connect/cluster-peering/usage/create-cluster-peering.mdx @@ -29,7 +29,7 @@ Mesh gateways are required for you to route service mesh traffic between partiti - A cluster requires a registered mesh gateway in order to export services to peers. - For Enterprise, this mesh gateway must also be registered in the same partition as the exported services and their `exported-services` configuration entry. - To use the `local` mesh gateway mode, you must register a mesh gateway in the importing cluster. -- + ## Create a peering token To begin the cluster peering process, generate a peering token in one of your clusters. The other cluster uses this token to establish the peering connection. diff --git a/website/content/docs/connect/cluster-peering/usage/k8s.mdx b/website/content/docs/connect/cluster-peering/usage/k8s.mdx index ca419d65719b..194bed21b605 100644 --- a/website/content/docs/connect/cluster-peering/usage/k8s.mdx +++ b/website/content/docs/connect/cluster-peering/usage/k8s.mdx @@ -7,9 +7,10 @@ description: >- # Cluster Peering on Kubernetes -To establish a cluster peering connection on Kubernetes, you need to enable several pre-requisite values in the Helm chart and create custom resource definitions (CRDs) for each side of the peering. +To establish a cluster peering connection on Kubernetes, you need to enable several values in the Helm chart and create custom resource definitions (CRDs) for each side of the peering. + +All peering connection traffic, including both data plane and control plane traffic, is routed through mesh gateways. As a result, the following Helm values for mesh gateways are mandatory for cluster peering: -The following Helm values are mandatory for cluster peering: - [`global.tls.enabled = true`](/docs/k8s/helm#v-global-tls-enabled) - [`meshGateway.enabled = true`](/docs/k8s/helm#v-meshgateway-enabled) @@ -18,18 +19,15 @@ The following CRDs are used to create and manage a peering connection: - `PeeringAcceptor`: Generates a peering token and accepts an incoming peering connection. - `PeeringDialer`: Uses a peering token to make an outbound peering connection with the cluster that generated the token. -Peering connections, including both data plane and control plane traffic, is routed through mesh gateways. -As of Consul v1.14, you can also [implement service failovers and redirects to control traffic](/consul/docs/connect/l7-traffic) between peers. - > To learn how to peer clusters and connect services across peers in AWS Elastic Kubernetes Service (EKS) environments, complete the [Consul Cluster Peering on Kubernetes tutorial](https://learn.hashicorp.com/tutorials/consul/cluster-peering-aws?utm_source=docs). ## Prerequisites You must implement the following requirements to create and use cluster peering connections with Kubernetes: -- Consul v1.14.0 or later +- Consul v1.14 or higher - At least two Kubernetes clusters -- The installation must be running on Consul on Kubernetes version 1.0.0 or later +- The installation must be running on Consul on Kubernetes v1.0.0 or later ### Prepare for installation @@ -97,6 +95,7 @@ the servers for that cluster. The servers for `cluster-02` will use that informa `cluster-01`. Complete the following steps to create the peer connection. ### Using mesh gateways for the peering connection + If the servers in `cluster-01` are not directly routable from the dialing cluster `cluster-02`, then you'll need to set up peering through mesh gateways. 1. In `cluster-01` apply the `Mesh` custom resource so the generated token will have the mesh gateway addresses which will be routable from the other cluster.