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.
4072 Commits
1703 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Tree: dd06007766
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'dd06007766'
${ noResults }
James Phillips dd06007766
Adds a vendoring cheat sheet. 		8 years ago
Godeps Updates armon/go-metrics and adds Circonus vendored libraries. 8 years ago
acl Renames "prepared_query" ACL policy to "query". 9 years ago
api api: add query templates 9 years ago
bench Fix Consul download link in benchmark scripts 9 years ago
command Tweaks the docs a bit. 8 years ago
consul Adds some supplemental tests for RPC "no leader" retries. 8 years ago
contrib Merge pull request #1863 from mssola/bash-completion 9 years ago
demo/vagrant-cluster update vagrant demo 9 years ago
lib Use a cryptographically secure seed 9 years ago
scripts Enables fallback git tag check to fix Travis. 9 years ago
terraform Add Terraform config for Google Cloud Platform 9 years ago
test Re-ups the snake oil certs for the unit tests. 9 years ago
testutil Misc comment improvements 9 years ago
tlsutil tlsutil: Testing hostname verification 10 years ago
types Revert "Move `structs.CheckID` to a new top-level package, `types`." 9 years ago
ui Updates web assets to pull in RTT viz. 9 years ago
vendor Updates armon/go-metrics and adds Circonus vendored libraries. 8 years ago
watch Update Check API to use constants 9 years ago
website Tweaks the docs a bit. 8 years ago
.gitignore Use gox for building 9 years ago
.travis.yml Bump Go to 1.6.2 for Travis (just added) 9 years ago
CHANGELOG.md Update CHANGELOG.md 8 years ago
GNUmakefile Add `tools/cmd/cover` to GOTOOLS 9 years ago
ISSUE_TEMPLATE.md Revise issue template to include a hint to use a gist 9 years ago
LICENSE Initial commit 11 years ago
README.md Adds a vendoring cheat sheet. 8 years ago
commands.go Gives RTT class a more Go-like name. 9 years ago
main.go Always seed math/rand on consul startup 9 years ago
main_test.go Adding basic CLI infrastructure 11 years ago
make.bat Removes the integration test runner, there weren't any tests using it. 9 years ago
version.go Switch version back to `dev` 9 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, and Windows. It is recommended to run the Consul servers only on Linux, however.

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 Godep for vendoring. These steps can be used to update dependencies in a controlled way.

Start by running a clean golang container:

docker run -i -t -v `pwd`:/go/src/github.com/hashicorp/consul golang sh

After that, you'll get a shell inside the container:

  1. Run go get github.com/tools/godep to install Godep.
  2. Run cd /go/src/github.com/hashicorp/consul to change to the Consul repo. Note that we mounted that as a volume above into the GOPATH.
  3. Run godep restore to update the container with the current state of dependencies based on what's vendored.
  4. Update dependencies as needed.
  5. Run godep save and look at the results carefully before committing.