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.
500 Commits
1703 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Tree: 7d359a41b5
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '7d359a41b5'
${ noResults }
Jack Pearkes 7d359a41b5
website: fix readme (serf -> consul) 		11 years ago
command command/members: API update for columnize 11 years ago
consul consul: Fix a 64bit alignment issue for x86-32 11 years ago
demo/vagrant-cluster demo: Adding a basic vagrant file for a simple cluster 11 years ago
scripts scripts: dist should have version in filename 11 years ago
test Adding testing certificates 11 years ago
website website: fix readme (serf -> consul) 11 years ago
.gitignore scripts: dist script 11 years ago
CHANGELOG.md Up version for dev 11 years ago
LICENSE Initial commit 11 years ago
Makefile consul: adding basic skeleton 11 years ago
README.md Update README 11 years ago
Vagrantfile Adding 32bit box to Vagrantfile 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 Up version for dev 11 years ago

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.