forked from hashicorp/consul
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
69 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
layout: docs | ||
page_title: 'Commands: Connect Expose' | ||
sidebar_title: expose | ||
description: > | ||
The connect expose subcommand is used to expose a Connect-enabled service | ||
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` | ||
|
||
The connect expose subcommand is used to expose a Connect-enabled service | ||
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 | ||
[Ingress gateway documentation](/docs/connect/ingress-gateway) for more information | ||
about Ingress gateways. | ||
|
||
```text | ||
Usage: consul connect expose [options] | ||
Exposes a Connect-enabled service through the given ingress gateway, using the | ||
given protocol and port. | ||
``` | ||
|
||
#### API Options | ||
|
||
@include 'http_api_options_client.mdx' | ||
|
||
@include 'http_api_options_server.mdx' | ||
|
||
#### Expose Options | ||
|
||
- `-ingress-gateway` - The name of the ingress gateway service to use. Required. | ||
|
||
- `-port` - The listener port to use for the service on the Ingress gateway. | ||
Required. | ||
|
||
- `-protocol` - The protocol for the service. Defaults to 'tcp'. Optional. | ||
|
||
- `-service` - The name of destination service to expose. Required. | ||
|
||
## 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" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters