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.
5646 Commits
1702 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Tree: efff41a8b2
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'efff41a8b2'
${ noResults }
James Phillips efff41a8b2
Updates built-in static assets for web UI. 		8 years ago
acl
…
api retry: Removes the description parameter. 8 years ago
bench
…
command Updates built-in static assets for web UI. 8 years ago
consul test: simplify joining clusters 8 years ago
contrib
…
demo/vagrant-cluster
…
lib golint: Fix existing comments 8 years ago
logger golint: Untangle if blocks with return in else 8 years ago
scripts build: Simplify make test and log output 8 years ago
snapshot golint: Drop the unused value from range 8 years ago
terraform Merge pull request #2849 from bbriggs/issue-2848 8 years ago
test Add tls client options to api/cli 8 years ago
testrpc test: Drop WaitForResult from testutil and testrpc 8 years ago
testutil test: simplify tests that check for peers 8 years ago
tlsutil Add TLS cipher suite options and CA path support (#2963) 8 years ago
types Removes remoteConsuls in favor of the new router. 8 years ago
ui Use updated ACL guide URL instead 8 years ago
vendor Updates vendored Raft library. 8 years ago
version Puts the tree in 0.8.2 dev mode. 8 years ago
watch golint: No stutter 8 years ago
website Fixup ACL docs 8 years ago
.gitignore build: cleanup .gitignore 8 years ago
.travis.yml Bump travis.yml to Go 1.8.1 (#2955) 8 years ago
CHANGELOG.md Update CHANGELOG.md 8 years ago
GNUmakefile Add make target for linux binary 8 years ago
ISSUE_TEMPLATE.md
…
LICENSE
…
README.md
…
commands.go golint: Rename fields and structs 8 years ago
main.go Remove duplicate constants 8 years ago
main_test.go
…
make.bat
…

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

Building Consul on Windows

Make sure Go 1.8+ is installed on your system and that the Go command is in your %PATH%.

For building Consul on Windows, you also need to have MinGW installed. TDM-GCC is a simple bundle installer which has all the required tools for building Consul with MinGW.

Install TDM-GCC and make sure it has been added to your %PATH%.

If all goes well, you should be able to build Consul by running make.bat from a command prompt.

See also golang/winstrap and golang/wiki/WindowsBuild for more information of how to set up a general Go build environment on Windows with MinGW.

Vendoring

Consul currently uses govendor for vendoring.