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.
4,393 Commits
1,705 Branches
457 Tags
690 MiB
Go 76.3%
SCSS 12.5%
JavaScript 5.4%
Handlebars 2.4%
Shell 2%
Other 1.3%
 
 
 
 
 
 
Go to file
James Phillips 8cae7b1f44
Puts tree back into development mode. 		2016-09-14 09:20:31 -07:00
acl Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands. 2016-08-30 00:02:50 -07:00
api Removes Raft types from public API interface. 2016-08-30 14:59:16 -07:00
bench Fix Consul download link in benchmark scripts 2016-02-10 14:18:19 -02:00
command Merge pull request #2263 from sweeneyb/dnsPort 2016-09-01 22:16:15 -07:00
consul Merge pull request #2319 from hashicorp/f-bootstrap-abort 2016-09-01 09:49:03 -07:00
contrib Merge pull request #1863 from mssola/bash-completion 2016-07-05 12:52:58 -07:00
demo/vagrant-cluster update vagrant demo 2016-04-27 17:52:23 -04:00
lib Use a cryptographically secure seed 2016-05-02 23:52:37 -07:00
scripts Use the `gox` binary found in a user's $PATH, which we assume includes 2016-08-10 23:55:40 -07:00
terraform Replace key_path with private_key and file() interpolation. 2016-08-30 12:27:05 +03:00
test Re-ups the snake oil certs for the unit tests. 2016-06-04 12:13:56 -07:00
testutil Adds performance tuning capability for Raft, detuned defaults, and supplemental docs. 2016-08-24 21:58:37 -07:00
tlsutil tlsutil: Testing hostname verification 2015-05-11 16:05:39 -07:00
types Revert "Move `structs.CheckID` to a new top-level package, `types`." 2016-06-07 16:59:02 -04:00
ui Updates built-in UI static assets to latest. 2016-08-12 18:01:59 -07:00
vendor Updates vendor info for memberlist. 2016-08-12 11:43:26 -07:00
watch Moves stale code to same spot and adds it everywhere that supports it. 2016-08-10 15:49:51 -07:00
website remove reference to localhost in operator.html.markdown 2016-09-14 12:12:27 +02:00
.gitignore Use gox for building 2015-10-22 14:16:01 -04:00
.travis.yml Bumps Travis to Go 1.6.3. 2016-08-16 15:25:43 -07:00
CHANGELOG.md Update CHANGELOG.md 2016-09-12 17:16:39 -07:00
GNUmakefile Add `tools/cmd/cover` to GOTOOLS 2016-05-07 13:02:12 -07: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 Tweaks platform information in the README. 2016-08-26 21:51:07 -07:00
commands.go Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands. 2016-08-30 00:02:50 -07:00
main.go Always seed math/rand on consul startup 2016-01-29 17:00:08 -08:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
make.bat Removes the integration test runner, there weren't any tests using it. 2015-10-26 11:34:01 -07:00
version.go Puts tree back into development mode. 2016-09-14 09:20:31 -07:00

README.md

Consul Build Status

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