github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
3,904 Commits
1,703 Branches
457 Tags
692 MiB
Go 76.3%
SCSS 12.5%
JavaScript 5.4%
Handlebars 2.4%
Shell 2%
Other 1.3%
 
 
 
 
 
 
Go to file
James Phillips a37bf9de56 Adds a read-only optimized path for transactions. 2016-05-13 00:34:05 -07:00
Godeps Updates BoltDB to v1.2.0 release. 2016-03-22 08:36:46 -07:00
acl Renames "prepared_query" ACL policy to "query". 2016-02-24 17:02:06 -08:00
api Adds a read-only optimized path for transactions. 2016-05-13 00:34:05 -07:00
bench Fix Consul download link in benchmark scripts 2016-02-10 14:18:19 -02:00
command Adds a read-only optimized path for transactions. 2016-05-13 00:34:05 -07:00
consul Adds a read-only optimized path for transactions. 2016-05-13 00:34:05 -07:00
contrib/zsh-completion Added help text for -dev option #1804 for zsh completion. 2016-03-28 19:32:02 +05:30
demo/vagrant-cluster update vagrant demo 2016-04-27 17:52:23 -04:00
lib Guard against divide by zero in lib.RandomStagger() 2016-04-23 13:11:32 -07:00
scripts Upgrades to Go 1.6.1. 2016-04-12 21:31:44 -07:00
terraform Fix shebangs in new scripts after rebasing 2016-03-11 08:59:08 -05:00
test Reissues cert for the unit tests, which expired a few days ago. 2015-05-27 15:08:58 -07:00
testutil Clean up the test example in README 2016-04-23 20:18:45 -07:00
tlsutil tlsutil: Testing hostname verification 2015-05-11 16:05:39 -07:00
ui Merge pull request #1702 from far-blue/ui-configurable-api-url 2016-03-18 21:05:00 -07:00
vendor Update Serf to include `serf.NumNodes()` 2016-03-23 22:10:50 -07:00
watch Update Check API to use constants 2016-04-23 16:01:59 -07:00
website Adds a read-only optimized path for transactions. 2016-05-13 00:34:05 -07:00
.gitignore Use gox for building 2015-10-22 14:16:01 -04:00
.travis.yml Takes away Go tip build which is failing for odd reasons. 2016-02-18 15:50:04 -08:00
CHANGELOG.md Update CHANGELOG.md 2016-04-24 23:08:59 -07:00
GNUmakefile Tweaks some of the default makefile targets. 2016-02-17 20:36:48 -08:00
ISSUE_TEMPLATE.md Revise issue template to include a hint to use a gist 2016-04-28 22:27:25 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
README.md Gets rid of obsolete go get command in the README. 2016-04-24 16:32:19 -07:00
commands.go Gives RTT class a more Go-like name. 2015-10-23 15:23:01 -07:00
main.go Always seed math/rand on consul startup 2016-01-29 17:00:08 -08:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
make.bat Removes the integration test runner, there weren't any tests using it. 2015-10-26 11:34:01 -07:00
version.go Switch version back to `dev` 2016-04-06 14:53:14 -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:

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