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.
7648 Commits
1702 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '274e5a2c7e'
${ noResults }
Go to file
Kyle Havlovitz 274e5a2c7e
Add a note about removals to the version upgrade docs 		7 years ago
acl Spelling (#3958) 7 years ago
agent Remove unused retry join structs from config 7 years ago
api Remove the script field from checks in favor of args 7 years ago
bench
…
command Merge pull request #4016 from pierresouchay/support_for_prometheus 7 years ago
demo Enables dig in cluster demo by installing dnsutils 7 years ago
ipaddr New config parser, HCL support, multiple bind addrs (#3480) 7 years ago
lib Update serf to pick up clean leave fix 7 years ago
logger
…
scripts Bumps go version to 1.10 7 years ago
sentinel Renames stubs to be more consistent. 7 years ago
snapshot Removes timeout when restoring snapshots. 7 years ago
terraform Spelling (#3958) 7 years ago
test Adds enable_agent_tls_for_checks configuration option which allows (#3661) 7 years ago
testrpc
…
testutil Spelling (#3958) 7 years ago
tlsutil 🐛 Formatting changes only; add missing trailing commas 7 years ago
types
…
ui Update static assets 7 years ago
vendor Update serf to pick up clean leave fix 7 years ago
version Put tree back into dev mode 7 years ago
watch Add package name to log output 7 years ago
website Add a note about removals to the version upgrade docs 7 years ago
.gitignore build: add changelogfmt target to format [GH-xxxx] references to links 7 years ago
.travis.yml Travis evaluates ENV before cloning git repo and cding so we need to delay gathering packages until the makefile 7 years ago
CHANGELOG.md Update CHANGELOG.md 7 years ago
GNUmakefile Revert timeout changes 7 years ago
INTERNALS.md Spelling (#3958) 7 years ago
ISSUE_TEMPLATE.md Reorders the issue template. 7 years ago
LICENSE
…
README.md Adds a link to Consul Enterprise in the README. 7 years ago
Vagrantfile Adds a basic Linux Vagrant setup, stolen from Nomad. 7 years ago
main.go Adds a registry mechanism for CLI commands. 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. A commercial version called Consul Enterprise is also available.

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. The test suite may fail if over-parallelized, so if you are seeing stochastic failures try GOTEST_FLAGS="-p 2 -parallel 2" 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 and vendorfmt for formatting vendor.json to a more merge-friendly "one line per package" format.