2018-05-29 21:07:40 +00:00
|
|
|
---
|
2020-09-01 15:14:13 +00:00
|
|
|
layout: commands
|
2020-04-06 20:27:35 +00:00
|
|
|
page_title: 'Commands: Connect'
|
2020-04-13 18:40:26 +00:00
|
|
|
sidebar_title: connect
|
2018-05-29 21:07:40 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Consul Connect
|
|
|
|
|
|
|
|
|
|
Command: `consul connect`
|
|
|
|
|
|
2020-11-30 15:54:59 +00:00
|
|
|
The `connect` command is used to interact with Consul
|
2020-04-09 23:46:54 +00:00
|
|
|
[Connect](/docs/connect/intentions) subsystems. It exposes commands for
|
2018-05-29 21:07:40 +00:00
|
|
|
running the built-in mTLS proxy and viewing/updating the Certificate Authority
|
|
|
|
|
(CA) configuration. This command is available in Consul 1.2 and later.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Usage: `consul connect <subcommand>`
|
|
|
|
|
|
|
|
|
|
For the exact documentation for your Consul version, run `consul connect -h` to view
|
|
|
|
|
the complete list of subcommands.
|
|
|
|
|
|
|
|
|
|
```text
|
|
|
|
|
Usage: consul connect <subcommand> [options] [args]
|
|
|
|
|
|
|
|
|
|
This command has subcommands for interacting with Consul Connect.
|
|
|
|
|
|
|
|
|
|
Here are some simple examples, and more detailed examples are available
|
|
|
|
|
in the subcommands or the documentation.
|
|
|
|
|
|
|
|
|
|
Run the built-in Connect mTLS proxy
|
|
|
|
|
|
|
|
|
|
$ consul connect proxy
|
|
|
|
|
|
|
|
|
|
For more examples, ask for subcommand help or view the documentation.
|
|
|
|
|
|
|
|
|
|
Subcommands:
|
2020-06-05 21:54:45 +00:00
|
|
|
ca Interact with the Consul Connect Certificate Authority (CA)
|
|
|
|
|
envoy Runs or Configures Envoy as a Connect proxy
|
|
|
|
|
expose Expose a Connect-enabled service through an Ingress gateway
|
|
|
|
|
proxy Runs a Consul Connect proxy
|
2018-05-29 21:07:40 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
For more information, examples, and usage about a subcommand, click on the name
|
2020-04-06 20:27:35 +00:00
|
|
|
of the subcommand in the sidebar.
|
