mirror of https://github.com/hashicorp/consul
32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
---
|
|
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
|