From 9d4c77a51f7a602f22be272714d027fe8832316f Mon Sep 17 00:00:00 2001 From: trujillo-adam Date: Fri, 21 Oct 2022 13:18:24 -0700 Subject: [PATCH] tweaks to the usage page for routing to peered services --- .../api-gateway/usage/route-to-peered-services.mdx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/website/content/docs/api-gateway/usage/route-to-peered-services.mdx b/website/content/docs/api-gateway/usage/route-to-peered-services.mdx index e89c9487ce..0ce8c4cbb6 100644 --- a/website/content/docs/api-gateway/usage/route-to-peered-services.mdx +++ b/website/content/docs/api-gateway/usage/route-to-peered-services.mdx @@ -1,6 +1,6 @@ --- -Page_title: Route Traffic to Peered Services -Description: Learn how to configure Consul API Gateway to route traffic to services connected to the mesh through a peering connection. +page_title: Route Traffic to Peered Services +description: Learn how to configure Consul API Gateway to route traffic to services connected to the mesh through a peering connection. --- # Route Traffic to Peered Services @@ -11,8 +11,9 @@ This topic describes how to configure Consul API Gateway to route traffic to ser 1. Verify that the [requirements](/docs/api-gateway/tech-specs) have been met. 1. Verify that the Consul API Gateway CRDs and controller have been installed and applied. Refer to [Installation](/docs/api-gateway/install) for details. -1. Verify that a peering connection has been established between Consul clusters and that the Consul service you want to route to has been exported to the cluster containing your `Gateway`. Refer to [Cluster Peering on Kubernetes](https://developer.hashicorp.com/consul/docs/connect/cluster-peering/k8s) for details. -1. Verify that a `ServiceResolver` has been created in the cluster containing your `Gateway` for the Consul service you want to route to +1. A peering connection must already be established between Consul clusters. Refer to [Cluster Peering on Kubernetes](/docs/connect/cluster-peering/k8s) for instructions. +1. The Consul service you want to route traffic to must be exported to the cluster containing your `Gateway`. Refer to [Cluster Peering on Kubernetes](/docs/connect/cluster-peering/k8s) for instructions. +1. A `ServiceResolver` for the Consul service you want to route traffic to must be created in the cluster that contains your `Gateway`. Refer to [Service Resolver Configuration Entry](/docs/connect/config-entries/service-resolver) for instructions. ## Configuration @@ -23,7 +24,7 @@ Configure the following fields in your `MeshService` configuration to use this f ## Example -In the following example, routes using `example-mesh-service` as a backend will send requests to the `echo` service exported by the peered Consul cluster, `cluster-02`. +In the following example, routes that use `example-mesh-service` as a backend are configured to send requests to the `echo` service exported by the peered Consul cluster `cluster-02`. @@ -53,7 +54,7 @@ spec: ``` -A `HTTPRoute` may then reference `example-mesh-service` as its `backendRef`. +After applying the configuration, an `HTTPRoute` may then reference `example-mesh-service` as its `backendRef`.