Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
 
 
 
 
 
 
Go to file
Scott Woods 7696a9f8be Fix bad copy/paste (#3139)
Description was probably originally copied from the "delete" request.
2017-06-10 14:46:25 -07:00
acl
agent pkg refactor 2017-06-10 18:52:45 +02:00
api
bench
command pkg refactor 2017-06-10 18:52:45 +02:00
contrib
demo/vagrant-cluster
ipaddr
lib
logger
scripts Removes obsolete Windows build scripts. 2017-06-09 01:13:28 -07:00
snapshot
terraform
test
testrpc pkg refactor 2017-06-10 18:52:45 +02:00
testutil
tlsutil
types
ui
vendor
version Puts the tree into 0.9.0 dev mode. 2017-06-09 08:27:15 -07:00
watch
website Fix bad copy/paste (#3139) 2017-06-10 14:46:25 -07:00
.gitignore
.travis.yml
CHANGELOG.md Update CHANGELOG.md 2017-06-09 21:11:16 -07:00
GNUmakefile pkg refactor 2017-06-10 18:52:45 +02:00
ISSUE_TEMPLATE.md
LICENSE
README.md
main.go simplify main.go 2017-06-10 18:52:45 +02:00
main_test.go

README.md

Consul Build Status Join the chat at https://gitter.im/hashicorp-consul/Lobby

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.