Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure. https://www.consul.io
Go to file
Matt Keeler c90d7f5160 Redo the build system
Improvements:
   - More modular
   - Building within docker doesn’t use volumes so can be run on a remote docker host
   - Build containers include only minimal context so they only rarely need to be rebuilt and most of the time can be used from the cache.
   - 3 build containers instead of 1. One based off of the upstream golang containers for building go stuff with all our required GOTOOLS installed. One like the old container based off ubuntu bionic for building the old UI (didn’t bother creating a much better container as this shouldn’t be needed once we completely remove the legacy UI). One for building the new UI. Its alpine based with all the node, ember, yarn stuff installed.
   - Top level makefile has the ability to do a container based build without running make dist
   - Can build for arbitrary platforms at the top level using: make consul-docker XC_OS=… XC_ARCH=…
   - overridable functionality to allow for customizations to the enterprise build (like to generate multiple binaries)
   - unified how we compile our go. always use gox even for dev-builds or rather always use the tooling around our scripts which will make sure things get copied to the correct places throughout the filesystem.
2018-06-12 16:55:52 -04:00
.github/ISSUE_TEMPLATE github: more tweaking of bug issue template 2018-05-10 17:29:50 -07:00
acl Spelling (#3958) 2018-03-19 16:56:00 +00:00
agent Merge pull request #4156 from hashicorp/enterprise-coexistence 2018-06-05 10:50:32 -04:00
api Remove the script field from checks in favor of args 2018-05-08 15:31:53 -07:00
bench Gets benchmarks running again and does a rough pass for 0.7.1. 2016-11-29 13:02:26 -08:00
build-support Redo the build system 2018-06-12 16:55:52 -04:00
command Merge pull request #4194 from hashicorp/fix-kv-del-validation 2018-06-05 16:58:14 +01:00
demo Enables dig in cluster demo by installing dnsutils 2018-04-13 18:01:42 +01:00
ipaddr New config parser, HCL support, multiple bind addrs (#3480) 2017-09-25 11:40:42 -07:00
lib Add a helper for generating Consul's user-agent string 2018-05-25 15:50:18 -04:00
logger golint: Untangle if blocks with return in else 2017-04-25 09:26:13 -07:00
sentinel Renames stubs to be more consistent. 2017-11-29 18:36:52 -08:00
snapshot Removes timeout when restoring snapshots. 2017-12-13 14:10:54 -08:00
terraform Spelling (#3958) 2018-03-19 16:56:00 +00:00
test Update test certificates that expire this year to be way in the future 2018-05-12 10:15:45 +01:00
testrpc agent: move agent/consul/structs to agent/structs 2017-08-09 14:32:12 +02:00
testutil Spelling (#3958) 2018-03-19 16:56:00 +00:00
tlsutil 🐛 Formatting changes only; add missing trailing commas 2018-03-15 10:19:46 -07:00
types Removes remoteConsuls in favor of the new router. 2017-03-16 16:42:19 -07:00
ui v1.1.0 UI Build 2018-05-11 17:05:20 +01:00
ui-v2 Initial progress on build system updates 2018-06-08 10:20:54 -04:00
vendor Remove bogus second yamux vendoring 2018-06-04 16:28:33 -04:00
version Put version.go back in dev mode 2018-05-22 10:16:59 -04:00
watch Add RunWithConfig and put Run signature back to normal 2018-05-31 20:22:14 -04:00
website Merge pull request #4169 from rskrishnar/adds-a-link-to-agent-config-options 2018-06-01 09:25:58 -07:00
.gitignore Update .gitignore - ignore some macos fs event notification stuff 2018-05-24 10:34:23 -04:00
.travis.yml Travis evaluates ENV before cloning git repo and cding so we need to delay gathering packages until the makefile 2018-02-21 12:54:23 +00:00
CHANGELOG.md Update CHANGELOG.md 2018-06-04 16:41:29 -04:00
GNUmakefile Redo the build system 2018-06-12 16:55:52 -04:00
INTERNALS.md Spelling (#3958) 2018-03-19 16:56:00 +00:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
README.md Adds a link to Consul Enterprise in the README. 2018-01-23 12:32:54 -08:00
Vagrantfile Adds a basic Linux Vagrant setup, stolen from Nomad. 2017-10-06 08:10:12 -07:00
main.go Adds a registry mechanism for CLI commands. 2017-11-29 18:36:52 -08:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00

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.