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.
6,081 Commits
1,701 Branches
457 Tags
685 MiB
Go 76.3%
SCSS 12.5%
JavaScript 5.4%
Handlebars 2.4%
Shell 2%
Other 1.3%
 
 
 
 
 
 
Go to file
James Phillips da0408c241 Update autopilot.html.md 2017-07-07 14:38:35 -07:00
acl Adds support to the ACL package for agent policies. 2016-12-14 07:07:41 -08:00
agent address review comments 2017-07-07 09:22:34 +02:00
api api: fix TestAPI_CatalogNodes test 2017-07-07 09:22:34 +02:00
bench Gets benchmarks running again and does a rough pass for 0.7.1. 2016-11-29 13:02:26 -08:00
command command: make TestExecCommandRun_CrossDC more resilient 2017-07-07 09:22:34 +02:00
configutil Moves flag slice helper into configutil. 2017-06-20 12:52:35 -07:00
contrib Merge pull request #1863 from mssola/bash-completion 2016-07-05 12:52:58 -07:00
demo/vagrant-cluster Install latest version by default 2017-03-01 13:19:59 -05:00
ipaddr agent: move isAddrANY to separate package 2017-05-15 22:44:43 +02:00
lib golint: Fix existing comments 2017-04-25 09:26:13 -07:00
logger golint: Untangle if blocks with return in else 2017-04-25 09:26:13 -07:00
scripts Fixes checked in web assets and associated build scripts. (#3173) 2017-06-21 14:43:07 -07:00
snapshot test: add helper for ioutil.TempDir/TempFile 2017-05-12 22:12:47 +02:00
terraform Update install.sh for Consul 0.8.3 2017-05-12 12:52:59 -04:00
test test: log exit code in cluster.bash 2017-06-08 14:06:10 +02:00
testrpc pkg refactor 2017-06-10 18:52:45 +02:00
testutil api: do not block in waitForLeader since the retry loop is handling this 2017-07-07 09:22:34 +02:00
tlsutil Add a path for transitioning to TLS on an existing cluster (#3001) 2017-05-10 14:25:48 -07:00
types Removes remoteConsuls in favor of the new router. 2017-03-16 16:42:19 -07:00
ui Updates static assets to latest. 2017-06-07 21:16:59 -07:00
vendor vendor: update golang.org/x/sys/unix 2017-07-07 13:38:44 +02:00
version Puts the tree into 0.9.0 dev mode. 2017-06-09 08:27:15 -07:00
watch Make sure to call cancel on the context 2017-06-27 16:22:57 -05:00
website Update autopilot.html.md 2017-07-07 14:38:35 -07:00
.gitignore build: build all packages together 2017-07-07 09:22:34 +02:00
.travis.yml Bumps Go version to 1.8.3. 2017-05-24 19:35:01 -07:00
CHANGELOG.md Update CHANGELOG.md 2017-07-07 12:34:53 -07:00
GNUmakefile build: build all packages together 2017-07-07 09:22:34 +02:00
ISSUE_TEMPLATE.md Revise issue template to include a hint to use a gist 2016-04-28 22:27:25 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
README.md Removes obsolete Windows batch file and instructions. 2017-06-09 01:11:38 -07:00
main.go simplify main.go 2017-06-10 18:52:45 +02:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00

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