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.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
784 Commits
1702 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Tree: bae3c1606c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'bae3c1606c'
${ noResults }
Mitchell Hashimoto bae3c1606c
command/agent: block windows socket errors 		11 years ago
bench bench: Read not representative, cache increasing read rate. 11 years ago
command command/agent: block windows socket errors 11 years ago
consul command/agent: find proper private IP on Windows 11 years ago
demo/vagrant-cluster Version bump for v0.2.0 11 years ago
scripts scripts: dist handles UI 11 years ago
test Adding testing certificates 11 years ago
ui Fix parentKey transitions to root 11 years ago
website Install docs includes OSX specific oneliner method 11 years ago
.gitignore ui: ignore compiled js, dist 11 years ago
.travis.yml Adding Travis file 11 years ago
CHANGELOG.md command/agent: block windows socket errors 11 years ago
LICENSE Initial commit 11 years ago
Makefile Add format task to all and silence large output 11 years ago
README.md Adding travis badge 11 years ago
Vagrantfile Using older OS's for compilation 11 years ago
commands.go command/info: Adding new info command 11 years ago
main.go main: Fixing app name 11 years ago
main_test.go Adding basic CLI infrastructure 11 years ago
version.go Version bump for v0.2.0 11 years ago

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:

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.