2020-06-05 21:54:45 +00:00
|
|
|
---
|
2020-09-01 15:14:13 +00:00
|
|
|
layout: commands
|
2020-06-05 21:54:45 +00:00
|
|
|
page_title: 'Commands: Connect Expose'
|
|
|
|
|
description: >
|
2023-05-05 17:41:40 +00:00
|
|
|
The connect expose subcommand is used to expose a mesh-enabled service
|
2020-06-05 21:54:45 +00:00
|
|
|
through an Ingress gateway by modifying the gateway's configuration and adding
|
|
|
|
|
an intention to allow traffic from the gateway to the service.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Consul Connect Expose
|
|
|
|
|
|
|
|
|
|
Command: `consul connect expose`
|
|
|
|
|
|
2023-05-05 17:41:40 +00:00
|
|
|
The connect expose subcommand is used to expose a mesh-enabled service
|
2020-06-05 21:54:45 +00:00
|
|
|
through an Ingress gateway by modifying the gateway's configuration and adding
|
|
|
|
|
an intention to allow traffic from the gateway to the service. See the
|
2023-01-25 16:52:43 +00:00
|
|
|
[Ingress gateway documentation](/consul/docs/connect/gateways/ingress-gateway) for more information
|
2020-06-05 21:54:45 +00:00
|
|
|
about Ingress gateways.
|
|
|
|
|
|
|
|
|
|
```text
|
|
|
|
|
Usage: consul connect expose [options]
|
|
|
|
|
|
2023-05-05 17:41:40 +00:00
|
|
|
Exposes a mesh-enabled service through the given ingress gateway, using the
|
2020-06-05 21:54:45 +00:00
|
|
|
given protocol and port.
|
|
|
|
|
```
|
|
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
#### Command Options
|
2020-06-05 21:54:45 +00:00
|
|
|
|
2020-06-05 22:47:03 +00:00
|
|
|
- `-ingress-gateway` - (Required) The name of the ingress gateway service to use.
|
2021-12-15 01:55:21 +00:00
|
|
|
A partition and namespace can optionally be specified as a prefix via the
|
|
|
|
|
'[[partition/]namespace]/service' format. If a partition is not specified 'default' is assumed.
|
|
|
|
|
If a partition is specified a namespace must be specified. Partitions and namespaces are Enterprise features.
|
2020-06-05 21:54:45 +00:00
|
|
|
|
2020-06-05 22:47:03 +00:00
|
|
|
- `-port` - (Required) The listener port to use for the service on the Ingress
|
|
|
|
|
gateway.
|
2020-06-05 21:54:45 +00:00
|
|
|
|
2020-06-05 22:47:03 +00:00
|
|
|
- `-service` - (Required) The name of destination service to expose. A namespace
|
2021-12-15 01:55:21 +00:00
|
|
|
can optionally be specified as a prefix via the '[[partition/]namespace]/service'
|
|
|
|
|
format. If a partition is not specified 'default' is assumed.
|
|
|
|
|
If a partition is specified a namespace must be specified. Partitions and namespaces are Enterprise features.
|
2020-06-05 21:54:45 +00:00
|
|
|
|
2020-06-08 23:59:47 +00:00
|
|
|
- `-protocol` - The protocol for the service. Defaults to 'tcp'.
|
|
|
|
|
|
2020-07-08 23:09:00 +00:00
|
|
|
- `-host` - Additional DNS hostname to use for routing to this service. Can be
|
2020-06-08 23:59:47 +00:00
|
|
|
specified multiple times.
|
|
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
#### API Options
|
|
|
|
|
|
|
|
|
|
@include 'http_api_options_client.mdx'
|
|
|
|
|
|
|
|
|
|
@include 'http_api_options_server.mdx'
|
|
|
|
|
|
2020-06-05 21:54:45 +00:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
The example below shows using the `expose` command to make the `foo` service available
|
|
|
|
|
through the Ingress gateway service `ingress`. The protocol argument is optional and
|
|
|
|
|
defaults to `tcp` if not provided.
|
|
|
|
|
|
|
|
|
|
```shell-session
|
|
|
|
|
$ consul connect expose -service=foo -ingress-gateway=ingress -port 8888 -protocol=tcp
|
|
|
|
|
Successfully updated config entry for ingress service "ingress"
|
|
|
|
|
Successfully set up intention for "ingress" -> "foo"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Running the command again when the config entry/intention are already set up will result
|
|
|
|
|
in a no-op:
|
|
|
|
|
|
|
|
|
|
```shell-session
|
|
|
|
|
$ consul connect expose -service=foo -ingress-gateway=ingress -port 8888 -protocol=tcp
|
|
|
|
|
Service "foo" already exposed through listener with port 8888
|
|
|
|
|
Intention already exists for "ingress" -> "foo"
|
|
|
|
|
```
|
