Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure. https://www.consul.io
Go to file
Seth Vargo c0d77a2ac3 Upgrading to Cedar-14 2015-04-26 15:33:53 -04:00
acl typofixes - https://github.com/vlajos/misspell_fixer 2014-12-04 23:25:06 +00:00
api testutil: Use HTTPAddr 2015-03-19 17:03:07 -07:00
bench Cut v0.5.0 2015-02-19 12:01:13 -08:00
command agent: parse raw query URL to avoid closing the request body early 2015-04-13 17:31:53 -07:00
consul Merge pull request #857 from hashicorp/f-boltdb 2015-04-10 18:30:07 -07:00
contrib/zsh-completion Add new 0.5 commands 2015-01-30 00:12:03 -08:00
demo/vagrant-cluster Cut v0.5.0 2015-02-19 12:01:13 -08:00
deps Adding the dep file for 0.5.0 2015-02-24 15:04:39 -08:00
scripts Add XXX to the end of mktemp template to support more linux versions. 2015-04-12 01:48:24 +00:00
terraform Upstart: Consul leave now works as expected. 2015-04-21 16:18:31 -04:00
test Add some basic smoke tests for wrapTLSclient. 2014-06-29 18:11:32 -07:00
testutil testutil: add a readme with sample usage 2015-04-22 20:46:59 -07:00
tlsutil Moved TLS Config stuff to tlsutil package 2014-11-18 11:03:36 -05:00
ui make sure button text overflow is set to ellipsis 2015-03-10 10:48:02 -07:00
watch api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
website Update middleman-hashicorp 2015-04-26 15:29:48 -04:00
.gitignore Update middleman-hashicorp 2015-04-26 15:29:48 -04:00
.travis.yml Only build pushes to master and PR's on travis 2015-02-17 12:33:08 -08:00
CHANGELOG.md Update CHANGELOG.md 2015-04-10 18:34:55 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
Makefile Build consul to a temp dir for API tests 2015-04-11 13:21:56 -07:00
README.md make.bat: add Makefile functionality for Windows 2015-01-25 06:35:56 +01:00
Vagrantfile Update Vagrantfile 2015-02-19 11:58:54 -08:00
commands.go Handle SIGTERM when running commands 2015-03-30 15:32:58 -07:00
main.go main: do not process -v or --version after a '--' 2015-03-11 16:33:55 -07:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
make.bat make.bat: add Makefile functionality for Windows 2015-01-25 06:35:56 +01:00
version.go version update for dev 2015-04-07 15:48:33 -07:00

README.md

Consul Build Status

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, and Windows. It is recommended to run the Consul servers only on Linux, however.

Quick Start

An extensive quick quick start is viewable on the Consul website:

http://www.consul.io/intro/getting-started/install.html

Documentation

Full, comprehensive documentation is viewable on the Consul website:

http://www.consul.io/docs

Developing Consul

If you wish to work on Consul itself, you'll first need Go installed (version 1.4+ 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:

$ go get -u ./...
$ 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.4+ 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.