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
510 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
Mitchell Hashimoto 655795e9d6 website: up version for website 2014-04-17 09:37:28 -07:00
command command/members: API update for columnize 2014-04-16 16:21:30 -07:00
consul consul: Fix a 64bit alignment issue for x86-32 2014-04-11 11:12:17 -07:00
demo/vagrant-cluster demo: Adding a basic vagrant file for a simple cluster 2014-04-10 17:34:10 -07:00
scripts scripts: dist should have version in filename 2014-04-16 22:00:35 -07:00
test Adding testing certificates 2014-04-07 15:07:00 -07:00
website website: up version for website 2014-04-17 09:37:28 -07:00
.gitignore scripts: dist script 2014-04-16 16:53:26 -07:00
CHANGELOG.md Up version for dev 2014-04-16 16:34:35 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
Makefile consul: adding basic skeleton 2013-12-06 15:43:07 -08:00
README.md Update README 2014-04-16 22:04:28 -07:00
Vagrantfile Adding 32bit box to Vagrantfile 2014-04-16 17:03:48 -07:00
commands.go command/info: Adding new info command 2014-02-23 16:59:32 -08:00
main.go main: Fixing app name 2014-04-11 16:23:05 -07:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
version.go Up version for dev 2014-04-16 16:34:35 -07:00

README.md

Consul

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