open-consul/website/source/docs/commands/connect.html.md
Mitchell Hashimoto 8dbe0017bb Starting Docs (#46)
* website: first stab at Connect docs

* website: lots more various stuff (bad commit messages)

* website: getting started page for Connect

* website: intentions

* website: intention APIs

* website: agent API docs

* website: document agent/catalog proxy kind service values

* website: /v1/catalog/connect/:service

* website: intention CLI docs

* website: custom proxy docs

* website: remove dedicated getting started guide

* website: add docs for CA API endpoints

* website: add docs for connect ca commands

* website: add proxy CLI docs

* website: clean up proxy command, add dev docs

* website: todo pages

* website: connect security
2018-06-25 12:24:05 -07:00

1.2 KiB

layout page_title sidebar_current
docs Commands: Connect docs-commands-connect

Consul Connect

Command: consul connect

The connect command is used to interact with Connect Connect subsystems. It exposes commands for 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.

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:
    ca       Interact with the Consul Connect Certificate Authority (CA)
    proxy    Runs a Consul Connect proxy

For more information, examples, and usage about a subcommand, click on the name of the subcommand in the sidebar.