From 03be4106c2fcf16ee23ab39664342b5ed3ff424c Mon Sep 17 00:00:00 2001 From: Mike Morris Date: Tue, 22 Feb 2022 16:05:39 -0500 Subject: [PATCH] website: add MeshService custom resource documentation --- website/content/docs/api-gateway/api-gateway.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/website/content/docs/api-gateway/api-gateway.mdx b/website/content/docs/api-gateway/api-gateway.mdx index 126defe0c1..a780b19717 100644 --- a/website/content/docs/api-gateway/api-gateway.mdx +++ b/website/content/docs/api-gateway/api-gateway.mdx @@ -317,3 +317,14 @@ spec: ``` + + +### MeshService + +MeshService holds a reference to an externally managed Consul Service Mesh service, and can be used as a `backendRef` for a [`Route`](#route). + +| Parameter | Description | Type | Default | +| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------- | +| `name` | Specifies the service name for a Consul service. It is assumed this service will exist in either the `consulDestinationNamespace` or mirrored Consul namespace from where this custom resource is defined, depending on the Helm configuration. + +Refer to the [Consul API Gateway repository](https://github.com/hashicorp/consul-api-gateway/blob/main/config/crd/bases/api-gateway.consul.hashicorp.com_meshservices.yaml) for the complete specification.