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.
4387 Commits
1702 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Tree: 495334e04e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '495334e04e'
${ noResults }
James Phillips 495334e04e
Cleaned up some errors and did a general edit pass. 		8 years ago
acl Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands. 8 years ago
api Removes Raft types from public API interface. 8 years ago
bench
…
command Merge pull request #2263 from sweeneyb/dnsPort 8 years ago
consul Merge pull request #2319 from hashicorp/f-bootstrap-abort 8 years ago
contrib
…
demo/vagrant-cluster
…
lib
…
scripts Use the `gox` binary found in a user's $PATH, which we assume includes 8 years ago
terraform Replace key_path with private_key and file() interpolation. 8 years ago
test
…
testutil Adds performance tuning capability for Raft, detuned defaults, and supplemental docs. 8 years ago
tlsutil
…
types
…
ui Updates built-in UI static assets to latest. 8 years ago
vendor Updates vendor info for memberlist. 8 years ago
watch
…
website Adds version note to near parameter. 8 years ago
.gitignore
…
.travis.yml Bumps Travis to Go 1.6.3. 8 years ago
CHANGELOG.md Cleaned up some errors and did a general edit pass. 8 years ago
GNUmakefile
…
ISSUE_TEMPLATE.md
…
LICENSE
…
README.md Tweaks platform information in the README. 8 years ago
commands.go Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands. 8 years ago
main.go
…
main_test.go
…
make.bat
…
version.go Puts tree back in dev mode. 8 years ago

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.