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.
7379 Commits
1701 Branches
457 Tags
678 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '41b1d45cc7'
${ noResults }
Go to file
Edd Steel 41b1d45cc7
Re-use defined endpoints for tests 		7 years ago
acl Cleans up some drift between the OSS and Enterprise trees. 7 years ago
agent Re-use defined endpoints for tests 7 years ago
api Add gRPC fields to client api and agent check endpoint docs 7 years ago
bench Gets benchmarks running again and does a rough pass for 0.7.1. 8 years ago
command Pull http config flag merge into public method 7 years ago
demo Merge pull request #3819 from burdandrei/docker-compose-demo 7 years ago
ipaddr New config parser, HCL support, multiple bind addrs (#3480) 7 years ago
lib remove golint warnings 7 years ago
logger golint: Untangle if blocks with return in else 8 years ago
scripts Bumps Go version back down to 1.9.3. 7 years ago
sentinel Renames stubs to be more consistent. 7 years ago
snapshot Removes timeout when restoring snapshots. 7 years ago
terraform consul upgraded to 1.0.0 in terraform scripts (#3588) 7 years ago
test Adds enable_agent_tls_for_checks configuration option which allows (#3661) 7 years ago
testrpc agent: move agent/consul/structs to agent/structs 7 years ago
testutil Bumps the standard retry up. 7 years ago
tlsutil Removes stale TLS config clone() in favor of new supported method. 7 years ago
types Removes remoteConsuls in favor of the new router. 8 years ago
ui Fixes erroneous closed <p> tag 7 years ago
vendor Fixes a panic on TCP-based DNS lookups. 7 years ago
version Puts the tree back into dev mode 7 years ago
watch watch: make sure invoke channels timeout evenutally 7 years ago
website Add gRPC fields to client api and agent check endpoint docs 7 years ago
.gitignore build: add changelogfmt target to format [GH-xxxx] references to links 7 years ago
.travis.yml Makes Travis build run less parallel. 7 years ago
CHANGELOG.md Puts the tree back into dev mode 7 years ago
GNUmakefile Switches to HashiCorp fork of jteeuwen/go-bindata. 7 years ago
INTERNALS.md Adds a basic INTERNALS.md guide with some pointers into the code. 7 years ago
ISSUE_TEMPLATE.md Reorders the issue template. 7 years ago
LICENSE
…
README.md Adds a link to Consul Enterprise in the README. 7 years ago
Vagrantfile Adds a basic Linux Vagrant setup, stolen from Nomad. 7 years ago
main.go Adds a registry mechanism for CLI commands. 7 years ago
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. A commercial version called Consul Enterprise is also available.

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.9+ 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. The test suite may fail if over-parallelized, so if you are seeing stochastic failures try GOTEST_FLAGS="-p 2 -parallel 2" 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 and vendorfmt for formatting vendor.json to a more merge-friendly "one line per package" format.