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,411 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
Sean Chittenden 53091c2b8b Add a note re: GH-1667 and redistributing client RPC requests 2016-02-02 11:38:00 -08:00
acl Adds a new management ACL for prepared queries. 2015-11-15 17:06:00 -08:00
api Use HTTPS + www. where appropriate 2016-01-13 17:44:01 -05:00
bench Bump version references 2015-05-18 14:37:27 -07:00
command Use panic instead of returning a sentinel UUID values in unit tests 2016-02-01 23:15:19 -08:00
consul Remove unnecessary check, test was moved further up in scope 2016-02-02 11:13:58 -08:00
contrib/zsh-completion Add new 0.5 commands 2015-01-30 00:12:03 -08:00
demo/vagrant-cluster Update consul version for vagrant demo 2016-01-13 17:56:19 -05:00
deps Adds deps for the 0.6.3 release. 2016-01-14 10:24:54 -08:00
lib Cull unused function and its unit test. 2016-02-01 23:15:19 -08:00
scripts Chase case change in the function name now that GenerateUUID is an 2016-02-01 23:15:19 -08:00
terraform gc duplicate platform variable 2015-06-25 08:39:22 +02: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 Fixes the static asset generator for new pkg path, updates assets. 2016-01-15 10:21:42 -08:00
watch api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
website fixing small typo in json 2016-01-29 01:25:23 -08:00
.gitignore Use gox for building 2015-10-22 14:16:01 -04:00
.travis.yml Un-pins Go version so we always run CI with the latest. 2016-01-07 18:31:29 -08:00
CHANGELOG.md Add a note re: GH-1667 and redistributing client RPC requests 2016-02-02 11:38:00 -08:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
Makefile Fixes the static asset generator for new pkg path, updates assets. 2016-01-15 10:21:42 -08:00
README.md Changes readme Go version to 1.5.3. 2016-01-14 19:55:57 -08:00
Vagrantfile Bumps up vbox resources for better unit test performance. 2016-01-14 10:15:48 -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.