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: 58b79d43b7

James Phillips 58b79d43b7 Updates the change log.		7 years ago
acl	acl: consolidate error handling (#3401 )	7 years ago
agent	agent: drop status code comments	7 years ago
api	Fix bug with unused (replaced with "") CONSUL_HTTP_AUTH in some places	7 years ago
bench	…
command	fix command/kv_import.go help text (#3387 )	7 years ago
configutil	Add catalog CLI functions (#3204 )	7 years ago
contrib	…
demo/vagrant-cluster	…
ipaddr	…
lib	…
logger	…
scripts	Upgrades Go version to 1.9.	7 years ago
snapshot	…
terraform	Update consul to version 0.9.0	7 years ago
test	test: log exit code in cluster.bash	8 years ago
testrpc	agent: move agent/consul/structs to agent/structs	7 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	Update raft library for windows snapshot fsync fixes. This fixes #3409	7 years ago
version	Puts tree in 0.9.3 dev mode.	7 years ago
watch	Use new DeletePrefixMethod for implementing KVSDeleteTree operation. This makes deletes on sub trees larger than one million nodes about 100 times faster. Added unit tests.	7 years ago
website	API DOCS: Update snapshot curl example (#3423 )	7 years ago
.gitignore	Removes "consul" from .gitignore.	7 years ago
.travis.yml	build: run vet on make test	7 years ago
CHANGELOG.md	Updates the change log.	7 years ago
GNUmakefile	Revert "Rename GNUMakefile to Makefile (#3348 )"	7 years ago
ISSUE_TEMPLATE.md	…
LICENSE	…
README.md	Upgrades Go version to 1.9.	7 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.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.