Consul is a tool for service discovery, monitoring and configuration.
Go HTML CSS JavaScript Shell HCL Other
Latest commit 65b7ed4 Feb 17, 2017 @slackpad slackpad committed on GitHub Update CHANGELOG.md
Permalink
Failed to load latest commit information.
acl Adds support to the ACL package for agent policies. Dec 14, 2016
api Update unix dial functions to use DialContext with new go-cleanhttp Feb 11, 2017
bench Gets benchmarks running again and does a rough pass for 0.7.1. Nov 29, 2016
command Condense raft subcommand into one doc page Feb 16, 2017
consul Round the node lookup prefix down to the nearest modulo two size before Feb 2, 2017
contrib Merge pull request #1863 from mssola/bash-completion Jul 5, 2016
demo/vagrant-cluster Demo: configurable Consul version Jan 13, 2017
lib Adds basic support for node IDs. Jan 18, 2017
logger Moves logger setup into its own package. (#2471) Nov 4, 2016
scripts Bumps Go version to 1.8. Feb 16, 2017
snapshot Adjusts location of archive test fixtures. Nov 4, 2016
terraform Removes an obsolete environment variable from the example upstart scr… Feb 2, 2017
test Add utility types to enable checking for unset flags Feb 8, 2017
testutil Update unix dial functions to use DialContext with new go-cleanhttp Feb 11, 2017
tlsutil Add TLSMinVersion to config options Feb 1, 2017
types Adds basic support for node IDs. Jan 18, 2017
ui UI: add notification for disabled JavaScript Jan 5, 2017
vendor Updates AWS Go SDK. Feb 17, 2017
version Points at new release and puts tree in 0.8.0 dev mode. Feb 6, 2017
watch Moves stale code to same spot and adds it everywhere that supports it. Aug 10, 2016
website Adds missing double quote Feb 16, 2017
.gitignore Use gox for building Oct 22, 2015
.travis.yml Bumps Go version to 1.8. Feb 16, 2017
CHANGELOG.md Update CHANGELOG.md Feb 17, 2017
GNUmakefile Revert `97904cec95f1a1fafd18405f0dd143eb63d595a9` Feb 2, 2017
ISSUE_TEMPLATE.md Revise issue template to include a hint to use a gist Apr 29, 2016
LICENSE Initial commit Nov 4, 2013
README.md Bumps Go version to 1.8. Feb 16, 2017
commands.go Split operator raft command into subcommands Feb 15, 2017
main.go Update website docs for validate command Feb 11, 2017
main_test.go Adding basic CLI infrastructure Dec 19, 2013
make.bat Removes the integration test runner, there weren't any tests using it. Oct 26, 2015

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 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.

Building Consul on Windows

Make sure Go 1.8+ is installed on your system and that the Go command is in your %PATH%.

For building Consul on Windows, you also need to have MinGW installed. TDM-GCC is a simple bundle installer which has all the required tools for building Consul with MinGW.

Install TDM-GCC and make sure it has been added to your %PATH%.

If all goes well, you should be able to build Consul by running make.bat from a command prompt.

See also golang/winstrap and golang/wiki/WindowsBuild for more information of how to set up a general Go build environment on Windows with MinGW.

Vendoring

Consul currently uses govendor for vendoring.