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.
 
 
 
 
 
 
James Phillips 859ac937a8
Puts the tree in 0.9.0 release mode.
7 years ago
acl
agent Fix UpgradeVersionTag field not being passed correctly (#3304) 7 years ago
api Add UpgradeVersionTag to autopilot config 7 years ago
bench
command Add UpgradeVersionTag to autopilot get/set commands 7 years ago
configutil Add catalog CLI functions (#3204) 7 years ago
contrib
demo/vagrant-cluster
ipaddr
lib
logger
scripts Removes the web UI as a separately released package. 7 years ago
snapshot
terraform
test
testrpc
testutil Adds new config to make script checks opt-in, updates documentation. (#3284) 7 years ago
tlsutil
types
ui UI cleanup follow up from #3245. (#3251) 7 years ago
vendor agent: add dependencies for docker on windows 7 years ago
version Puts the tree in 0.9.0 release mode. 7 years ago
watch Expands and rework context support in the API client. (#3273) 7 years ago
website Clarifies endpoint blocking in the docs. 7 years ago
.gitignore update .gitignore 7 years ago
.travis.yml build: run vet on make test 7 years ago
CHANGELOG.md Puts the tree in 0.9.0 release mode. 7 years ago
GNUmakefile build: fix travis build 7 years ago
ISSUE_TEMPLATE.md
LICENSE
README.md
main.go
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.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.