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

Go to file

Frank Schroeder 6c053d5139 Update CHANGELOG.md		7 years ago
acl	…
agent	agent: replace docker check	7 years ago
api	Adds new config to make script checks opt-in, updates documentation. (#3284 )	7 years ago
bench	…
command	Adds new config to make script checks opt-in, updates documentation. (#3284 )	7 years ago
configutil	Add catalog CLI functions (#3204 )	7 years ago
contrib	…
demo/vagrant-cluster	…
ipaddr	…
lib	…
logger	…
scripts	Removes the web UI as a separately released package.	7 years ago
snapshot	…
terraform	…
test	test: log exit code in cluster.bash	8 years ago
testrpc	pkg refactor	8 years ago
testutil	Adds new config to make script checks opt-in, updates documentation. (#3284 )	7 years ago
tlsutil	…
types	…
ui	UI cleanup follow up from #3245 . (#3251 )	7 years ago
vendor	agent: replace docker check	7 years ago
version	Bumps tree into 0.9.0-rc1 release mode.	7 years ago
watch	Expands and rework context support in the API client. (#3273 )	7 years ago
website	Update acl.html.md	7 years ago
.gitignore	update .gitignore	7 years ago
.travis.yml	build: run vet on make test	7 years ago
CHANGELOG.md	Update CHANGELOG.md	7 years ago
GNUmakefile	build: fix travis build	7 years ago
ISSUE_TEMPLATE.md	…
LICENSE	…
README.md	Removes obsolete Windows batch file and instructions.	8 years ago
main.go	simplify main.go	8 years ago
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.8+ 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.