Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
 
 
 
 
 
 
Go to file
Kyle Havlovitz 8b31eef467
Add base command option for hiding generated help for normal args
2017-09-28 18:43:28 -07:00
acl
agent Fix tests after config refactor 2017-09-28 12:32:46 +02:00
api Recursive sanitize (#3505) 2017-09-27 11:47:40 -07:00
bench
command Add base command option for hiding generated help for normal args 2017-09-28 18:43:28 -07:00
configutil
contrib
demo/vagrant-cluster
ipaddr
lib
logger
scripts
sentinel
snapshot
terraform
test Makes porter take over if an existing instance died. 2017-09-26 16:25:18 -07:00
testrpc
testutil agent: consolidate handling of 405 Method Not Allowed (#3405) 2017-09-25 23:11:19 -07:00
tlsutil
types
ui
vendor Recursive sanitize (#3505) 2017-09-27 11:47:40 -07:00
version Puts the tree in 1.0.0-beta1 release mode. 2017-09-27 16:20:48 -07:00
watch
website Update docs on RFC1464 vs RFC1035 options 2017-09-28 12:32:46 +02:00
.gitignore
.travis.yml
CHANGELOG.md Update CHANGELOG.md 2017-09-28 15:40:07 -07:00
GNUmakefile
ISSUE_TEMPLATE.md
LICENSE
README.md
main.go
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.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.