status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
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. https://www.consul.io
3,498 Commits 445 Branches 179 Tags 481 MiB
Go 65.8%
MDX 16.4%
SCSS 9.4%
JavaScript 4.1%
Handlebars 1.8%
Other 2.4%
Go to file
James Phillips baef89a8f6 Removes from cruft from the makefile. 2016-02-17 20:30:06 -08:00
Godeps Update go-cleanhttp 2016-02-17 17:03:57 -05:00
acl Adds a new management ACL for prepared queries. 2015-11-15 17:06:00 -08:00
api Adds support for EnableTagOverride to the API client. 2016-02-16 11:45:29 -08:00
bench Fix Consul download link in benchmark scripts 2016-02-10 14:18:19 -02:00
command Merge pull request #1703 from alistanis/fix-issue-#1661 2016-02-16 20:13:36 -08:00
consul Adds a test for node registration and tagged addresses. 2016-02-07 13:15:22 -08:00
contrib/zsh-completion Don't assume /bin/bash is installed on all OSes 2016-02-02 15:16:49 -08:00
demo/vagrant-cluster Update consul version for vagrant demo 2016-01-13 17:56:19 -05:00
lib Cull unused function and its unit test. 2016-02-01 23:15:19 -08:00
scripts Manage dependencies via Godep 2016-02-12 16:50:37 -08:00
terraform Add eu-west-1 and eu-central-1 to the map. 2016-02-17 09:16:41 +01:00
test Reissues cert for the unit tests, which expired a few days ago. 2015-05-27 15:08:58 -07:00
testutil Update cleanhttp repo location 2015-10-22 14:14:22 -04:00
tlsutil tlsutil: Testing hostname verification 2015-05-11 16:05:39 -07:00
ui Acknowledge that we're using GNU make's dialect and rename appropriate 2016-02-05 14:24:26 -08:00
vendor Update go-cleanhttp 2016-02-17 17:03:57 -05:00
watch api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
website Update leader-election.html.markdown 2016-02-14 09:32:23 -05:00
.gitignore Use gox for building 2015-10-22 14:16:01 -04:00
.travis.yml Starts switch to Go 1.6. 2016-02-17 19:43:55 -08:00
CHANGELOG.md Adds a note about the new go-cleanhttp behavior to the change log. 2016-02-17 14:49:24 -08:00
GNUmakefile Removes from cruft from the makefile. 2016-02-17 20:30:06 -08:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
README.md Changes readme Go version to 1.5.3. 2016-01-14 19:55:57 -08:00
Vagrantfile Starts switch to Go 1.6. 2016-02-17 19:43:55 -08: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 Puts tree in state ready for work on Consul 0.7. 2016-01-14 16:03:08 -08: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.5.3+ 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.5.3+ 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.