Go to file
Armon Dadgar fe7d82287b website: Fixing link to github 2014-04-14 11:56:13 -07:00
command agent: Testing start_join parsing 2014-04-11 17:03:19 -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 Update scripts for cross-compile 2014-02-22 14:57:19 -08:00
test Adding testing certificates 2014-04-07 15:07:00 -07:00
website website: Fixing link to github 2014-04-14 11:56:13 -07:00
.gitattributes Initial commit 2013-11-04 14:15:27 -08:00
.gitignore website: More info on TLS encryption 2014-04-07 15:07:21 -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 Filling in READMe 2014-04-14 11:45:31 -07:00
Vagrantfile Vagrantfile 2014-03-05 15:06:01 -08: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 Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00

README.md

Consul

Consul is a tool for managing and coordinating infrastructure. To do that it provides several key features:

  • Service Discovery - Services can register themselves and to easily discover other services via a DNS or HTTP interface.

  • 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 Store - 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 on Linux however.

Quick Start

First, download a pre-built Consul binary for your operating system or compile Consul yourself.

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

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

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.