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

consul api-gateway kubernetes ecs service-discovery service-mesh vault

Tree: 51a04ec87d

Preetha Appan 51a04ec87d Introduces new 'list' permission that applies to KV store recursive reads, and enforced only when opted in.		7 years ago
acl	Introduces new 'list' permission that applies to KV store recursive reads, and enforced only when opted in.	7 years ago
agent	Introduces new 'list' permission that applies to KV store recursive reads, and enforced only when opted in.	7 years ago
api	Recursive sanitize (#3505 )	7 years ago
bench	…
command	Split BaseCommand http config into a separate function	7 years ago
configutil	…
contrib	…
demo/vagrant-cluster	…
ipaddr	New config parser, HCL support, multiple bind addrs (#3480 )	7 years ago
lib	Adds open source side of network segments (feature is Enterprise-only).	7 years ago
logger	…
scripts	build: fix scripts/dist.sh	7 years ago
sentinel	Introduce Code Policy validation via sentinel, with a noop implementation	7 years ago
snapshot	…
terraform	Fix a typo in output.	7 years ago
test	Makes porter take over if an existing instance died.	7 years ago
testrpc	…
testutil	agent: consolidate handling of 405 Method Not Allowed (#3405 )	7 years ago
tlsutil	…
types	…
ui	Update coord display in ui to account for segments	7 years ago
vendor	Recursive sanitize (#3505 )	7 years ago
version	Puts the tree in 1.0.0-beta1 release mode.	7 years ago
watch	…
website	Update snapshot agent docs	7 years ago
.gitignore	…
.travis.yml	Removes Go 1.8.x.	7 years ago
CHANGELOG.md	Update CHANGELOG.md	7 years ago
GNUmakefile	New config parser, HCL support, multiple bind addrs (#3480 )	7 years ago
ISSUE_TEMPLATE.md	…
LICENSE	…
README.md	Upgrades Go version to 1.9.	7 years ago
main.go	…
main_test.go	…

README.md

Consul

Website: https://www.consul.io
Chat: Gitter
Mailing list: Google Groups

Consul is a tool for service discovery and configuration. Consul is distributed, highly available, and extremely scalable.

Consul provides several key features:

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.
Multi-Datacenter - Consul is built to be datacenter aware, and can support any number of regions without complex configuration.

Consul runs on Linux, Mac OS X, FreeBSD, Solaris, and Windows.

Quick Start

An extensive quick start is viewable on the Consul website:

https://www.consul.io/intro/getting-started/install.html

Documentation

Full, comprehensive documentation is viewable on the Consul website:

https://www.consul.io/docs

Developing Consul

If you wish to work on Consul itself, you'll first need Go installed (version 1.9+ is required). Make sure you have Go properly installed, including setting up your GOPATH.

Next, clone this repository into $GOPATH/src/github.com/hashicorp/consul and then just type make. In a few moments, you'll have a working consul executable:

$ make
...
$ bin/consul
...

Note: make will build all os/architecture combinations. Set the environment variable CONSUL_DEV=1 to build it just for your local machine's os/architecture, or use make dev.

Note: make will also place a copy of the binary in the first part of your $GOPATH.

You can run tests by typing make test.

If you make any changes to the code, run make format in order to automatically format the code according to Go standards.

Vendoring

Consul currently uses govendor for vendoring.