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.
6861 Commits
1702 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'cfc891fc25'
${ noResults }
Go to file
Frank Schroeder cfc891fc25
config: document dns options 		7 years ago
acl Cleans up some drift between the OSS and Enterprise trees. 7 years ago
agent config: document dns options 7 years ago
api Simplify string(buf.Bytes()) to buf.String() (#3590) 7 years ago
bench
…
command Updates documentation for consul validate. 7 years ago
contrib
…
demo/vagrant-cluster
…
ipaddr
…
lib test: replace porter tool with freeport lib 7 years ago
logger
…
scripts
…
sentinel
…
snapshot
…
terraform consul upgraded to 1.0.0 in terraform scripts (#3588) 7 years ago
test test: replace porter tool with freeport lib 7 years ago
testrpc
…
testutil test: replace porter tool with freeport lib 7 years ago
tlsutil
…
types
…
ui Fixes an XSS issue with unescaped node names. (#3578) 7 years ago
vendor Update serf library to pick up coordinate persistence fix 7 years ago
version Puts the tree in 1.0.1 dev mode. 7 years ago
watch Cleans up import sorting. 7 years ago
website Changes "ip" to "IP". 7 years ago
.gitignore
…
.travis.yml
…
CHANGELOG.md Update CHANGELOG.md 7 years ago
GNUmakefile test: replace porter tool with freeport lib 7 years ago
ISSUE_TEMPLATE.md
…
LICENSE
…
README.md
…
Vagrantfile
…
main.go Autocomplete support 7 years ago
main_test.go
…

README.md

Consul Build Status Join the chat at https://gitter.im/hashicorp-consul/Lobby

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, FreeBSD, Solaris, and Windows.

Quick Start

An extensive 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.9+ 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 build all os/architecture combinations. Set the environment variable CONSUL_DEV=1 to build it just for your local machine's os/architecture, or use make dev.

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.

Vendoring

Consul currently uses govendor for vendoring.