Go to file
Blake Covarrubias d14ddb7a23 docs: Clarify configuration options apply to agent
Recently there have been a handful of GitHub issues and Discuss posts
where users have expected the `consul` CLI to make use of config
options defined in the agent configuration files, and are confused
when it does not honor those config options.

This change clarifies that command-line and configuration file options
documented on the /agent/options page only apply to the Consul agent,
instead of the Consul CLI.
2022-03-03 11:30:20 -08:00
.changelog Merge pull request #12298 from jorgemarey/b-persistnewrootandconfig 2022-03-03 11:03:50 -05:00
.circleci connect: Update supported Envoy versions to include 1.19.3 and 1.18.6 2022-02-24 16:59:33 -08:00
.github Remove setup-qemu step from Docker build job (#12387) 2022-02-24 12:35:47 -08:00
.release Adding post-publish events to ci.hcl. 2022-02-17 16:54:36 +00:00
acl Refactor to make ACL errors more structured. (#12308) 2022-02-11 12:53:23 -08:00
agent Merge pull request #12298 from jorgemarey/b-persistnewrootandconfig 2022-03-03 11:03:50 -05:00
api fix godoc comment for Namespaces client method 2022-02-18 04:15:55 +00:00
bench
build-support Fix build script (#12367) 2022-02-16 11:52:44 -08:00
command catalog: compare node names case insensitively in more places (#12444) 2022-02-24 16:54:47 -06:00
connect bulk rewrite using this script 2022-01-20 10:46:23 -06:00
contributing Move contributing to docs 2021-08-30 16:17:09 -04:00
docs Add 7th check registration flow to docs 2022-02-11 15:11:22 -05:00
grafana add readme outlining how to edit and publish 2021-01-12 14:47:11 -08:00
internal testing: remove unnecessary calls to freeport 2021-11-29 12:19:43 -05:00
ipaddr Ensure Consul is IPv6 compliant (#5468) 2019-06-04 10:02:38 -04:00
lib Vendor in rpc mono repo for net/rpc fork, go-msgpack, msgpackrpc. (#12311) 2022-02-14 09:45:45 -08:00
logging bulk rewrite using this script 2022-01-20 10:46:23 -06:00
proto streaming: split event buffer by key (#12080) 2022-01-28 12:27:00 +00:00
sdk raft: update to v1.3.5 (#12325) 2022-02-14 13:48:52 -06:00
sentinel re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
service_os re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
snapshot Vendor in rpc mono repo for net/rpc fork, go-msgpack, msgpackrpc. (#12311) 2022-02-14 09:45:45 -08:00
terraform terraform: remove modules in repo (#5085) 2019-04-04 16:31:43 -07:00
test connect: Update supported Envoy versions to include 1.19.3 and 1.18.6 2022-02-24 16:59:33 -08:00
testrpc ca: remove unused provider.ActiveRoot call 2022-01-06 16:56:48 -05:00
tlsutil regenerate expired certs (#11462) 2021-11-01 11:40:16 -04:00
types ingress: allow setting TLS min version and cipher suites in ingress gateway config entries (#11576) 2022-01-11 11:46:42 -05:00
ui ui: Add docs for `<Action />` component (#12502) 2022-03-03 12:59:25 +00:00
version update main to reflect it is v1.12.0-dev (#12157) 2022-01-21 15:03:11 -06:00
website docs: Clarify configuration options apply to agent 2022-03-03 11:30:20 -08:00
.dockerignore Update the scripting 2018-06-14 21:42:47 -04:00
.gitattributes
.gitignore website: remove netlify artifacts and port missing redirects over to new format (#9601) 2021-01-21 10:16:17 -05:00
.golangci.yml ci: Add explanation in forbidigo (#12140) 2022-01-20 13:07:10 -05:00
CHANGELOG.md Add changelog entries from latest releases (#12473) 2022-02-28 17:49:37 -08:00
Dockerfile Update docker image base to alpine:3.15 (#12276) 2022-02-04 13:56:39 -08:00
GNUmakefile build: ensure 'make linux' puts the binary in the expected location (#12494) 2022-03-02 14:18:26 -06:00
INTERNALS.md Move contributing to docs 2021-08-30 16:17:09 -04:00
LICENSE
NOTICE.md add copyright notice file 2018-07-09 10:58:26 -07:00
README.md Adjust README header to work in light and dark modes 2022-02-07 16:46:46 -08:00
Vagrantfile Adds a basic Linux Vagrant setup, stolen from Nomad. 2017-10-06 08:10:12 -07:00
codecov.yml Update all the references in CI and makefile to the bindata file location 2020-10-01 16:19:10 +01:00
go.mod raft: upgrade to v1.3.6 (#12496) 2022-03-02 17:00:02 -06:00
go.sum raft: upgrade to v1.3.6 (#12496) 2022-03-02 17:00:02 -06:00
main.go cmd: introduce a shim to expose Stdout/Stderr writers 2021-06-02 16:51:34 -04:00
main_test.go
package-lock.json Adding UI screenshots to L7 overview 2022-01-10 14:34:00 -05:00

README.md

Consul logo Consul

Docker Pulls Go Report Card

Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.

Consul provides several key features:

  • Multi-Datacenter - Consul is built to be datacenter aware, and can support any number of regions without complex configuration.

  • Service Mesh/Service Segmentation - Consul Connect enables secure service-to-service communication with automatic TLS encryption and identity-based authorization. Applications can use sidecar proxies in a service mesh configuration to establish TLS connections for inbound and outbound connections without being aware of Connect at all.

  • Service Discovery - Consul makes it simple for services to register themselves and to discover other services via a DNS or HTTP interface. External services such as SaaS providers can be registered as well.

  • Health Checking - Health Checking enables Consul to quickly alert operators about any issues in a cluster. The integration with service discovery prevents routing traffic to unhealthy hosts and enables service level circuit breakers.

  • Key/Value Storage - A flexible key/value store enables storing dynamic configuration, feature flagging, coordination, leader election and more. The simple HTTP API makes it easy to use anywhere.

Consul runs on Linux, macOS, FreeBSD, Solaris, and Windows and includes an optional browser based UI. A commercial version called Consul Enterprise is also available.

Please note: We take Consul's security and our users' trust very seriously. If you believe you have found a security issue in Consul, please responsibly disclose by contacting us at security@hashicorp.com.

Quick Start

A few quick start guides are available on the Consul website:

Documentation

Full, comprehensive documentation is available on the Consul website:

https://www.consul.io/docs

Contributing

Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance. For contributions specifically to the browser based UI, please refer to the UI's README.md for guidance.