status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add page for MeshService configuration object for Consul API Gateway

This commit is contained in:
Nathan Coleman 2022-08-15 11:13:18 -04:00
parent 3f9debf7a1
commit 467bfb15ac
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
website/content/docs/api-gateway/configuration/meshservice.mdx Normal file
View File

@ -0,0 +1,31 @@
---
layout: docs
page_title: Consul API Gateway MeshService
description: >-
This topic describes how to configure the Consul API Gateway MeshService object
---
# MeshService
This topic provides full details about the MeshService resource.
## Introduction
A `MeshService` is a resource in the Kubernetes cluster that represents a service in the Consul service mesh outside the Kubernetes cluster where Consul API Gateway is deployed. The service must be in the same Consul datacenter. The MeshService exists so that other configuration models in Kubernetes, such as HTTPRoute and TCPRoute, can reference services that only exist in Consul.
## Configuration Model
The following outline shows how to format the configurations in the `MeshService` object. Click on a property name to view details about the configuration.
* [`name`](#name): string | required
## Specification
This topic provides details about the configuration parameters.
### name
Specifies the name of the service in the Consul service mesh to send traffic to.
* Type: string
* Required: required