Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.

consul api-gateway kubernetes ecs service-discovery service-mesh vault

Go to file

Dhia Ayachi 16b19dd82d auto-reload configuration when config files change (#12329 ) * add config watcher to the config package * add logging to watcher * add test and refactor to add WatcherEvent. * add all API calls and fix a bug with recreated files * add tests for watcher * remove the unnecessary use of context * Add debug log and a test for file rename * use inode to detect if the file is recreated/replaced and only listen to create events. * tidy ups (#1535) * tidy ups * Add tests for inode reconcile * fix linux vs windows syscall * fix linux vs windows syscall * fix windows compile error * increase timeout * use ctime ID * remove remove/creation test as it's a use case that fail in linux * fix linux/windows to use Ino/CreationTime * fix the watcher to only overwrite current file id * fix linter error * fix remove/create test * set reconcile loop to 200 Milliseconds * fix watcher to not trigger event on remove, add more tests * on a remove event try to add the file back to the watcher and trigger the handler if success * fix race condition * fix flaky test * fix race conditions * set level to info * fix when file is removed and get an event for it after * fix to trigger handler when we get a remove but re-add fail * fix error message * add tests for directory watch and fixes * detect if a file is a symlink and return an error on Add * rename Watcher to FileWatcher and remove symlink deref * add fsnotify@v1.5.1 * fix go mod * do not reset timer on errors, rename OS specific files * rename New func * events trigger on write and rename * add missing test * fix flaking tests * fix flaky test * check reconcile when removed * delete invalid file * fix test to create files with different mod time. * back date file instead of sleeping * add watching file in agent command. * fix watcher call to use new API * add configuration and stop watcher when server stop * add certs as watched files * move FileWatcher to the agent start instead of the command code * stop watcher before replacing it * save watched files in agent * add add and remove interfaces to the file watcher * fix remove to not return an error * use `Add` and `Remove` to update certs files * fix tests * close events channel on the file watcher even when the context is done * extract `NotAutoReloadableRuntimeConfig` is a separate struct * fix linter errors * add Ca configs and outgoing verify to the not auto reloadable config * add some logs and fix to use background context * add tests to auto-config reload * remove stale test * add tests to changes to config files * add check to see if old cert files still trigger updates * rename `NotAutoReloadableRuntimeConfig` to `StaticRuntimeConfig` * fix to re add both key and cert file. Add test to cover this case. * review suggestion Co-authored-by: R.B. Boyer <4903+rboyer@users.noreply.github.com> * add check to static runtime config changes * fix test * add changelog file * fix review comments * Apply suggestions from code review Co-authored-by: R.B. Boyer <4903+rboyer@users.noreply.github.com> * update flag description Co-authored-by: FFMMM <FFMMM@users.noreply.github.com> * fix compilation error * add static runtime config support * fix test * fix review comments * fix log test * Update .changelog/12329.txt Co-authored-by: Dan Upton <daniel@floppy.co> * transfer tests to runtime_test.go * fix filewatcher Replace to not deadlock. * avoid having lingering locks Co-authored-by: R.B. Boyer <4903+rboyer@users.noreply.github.com> * split ReloadConfig func * fix warning message Co-authored-by: R.B. Boyer <4903+rboyer@users.noreply.github.com> * convert `FileWatcher` into an interface * fix compilation errors * fix tests * extract func for adding and removing files Co-authored-by: Ashwin Venkatesh <ashwin@hashicorp.com> Co-authored-by: R.B. Boyer <4903+rboyer@users.noreply.github.com> Co-authored-by: FFMMM <FFMMM@users.noreply.github.com> Co-authored-by: Daniel Upton <daniel@floppy.co>		3 years ago
.changelog	auto-reload configuration when config files change (#12329 )	3 years ago
.circleci	build: auto install correct version of protoc locally (#12651 )	3 years ago
.github	Add example of goimports -local	3 years ago
.release	[RelAPI Onboarding] Add release API metadata file (#12591 )	3 years ago
acl	Fixups for error messages from ACL Errors (#12620 )	3 years ago
agent	auto-reload configuration when config files change (#12329 )	3 years ago
api	xds: adding control of the mesh-wide min/max TLS versions and cipher suites from the mesh config entry (#12601 )	3 years ago
bench	Gets benchmarks running again and does a rough pass for 0.7.1.	8 years ago
build-support	build: run mog separately after the protobufs are generated (#12665 )	3 years ago
command	auto-reload configuration when config files change (#12329 )	3 years ago
connect	Bump go-control-plane	3 years ago
contributing	Move contributing to docs	3 years ago
docs	Restructure gRPC server setup (#12586 )	3 years ago
grafana	add readme outlining how to edit and publish	4 years ago
internal	Add IAM Auth Method (#12583 )	3 years ago
ipaddr	Ensure Consul is IPv6 compliant (#5468 )	6 years ago
lib	auto-reload configuration when config files change (#12329 )	3 years ago
logging	bulk rewrite using this script	3 years ago
proto	Bump go-control-plane	3 years ago
sdk	raft: update to v1.3.5 (#12325 )	3 years ago
sentinel	re-run gofmt on 1.17 (#11579 )	3 years ago
service_os	re-run gofmt on 1.17 (#11579 )	3 years ago
snapshot	Vendor in rpc mono repo for net/rpc fork, go-msgpack, msgpackrpc. (#12311 )	3 years ago
terraform	terraform: remove modules in repo (#5085 )	6 years ago
test	connect: Update supported Envoy versions to include 1.19.3 and 1.18.6	3 years ago
testrpc	ca: remove unused provider.ActiveRoot call	3 years ago
tlsutil	agent: convert listener config to TLS types (#12522 )	3 years ago
types	agent: convert listener config to TLS types (#12522 )	3 years ago
ui	ui: Tile CSS component (#12570 )	3 years ago
version	update main to reflect it is v1.12.0-dev (#12157 )	3 years ago
website	website: redirect /api to /api-docs (#12660 )	3 years ago
.dockerignore	Update the scripting	7 years ago
.gitignore	build: auto install correct version of protoc locally (#12651 )	3 years ago
.golangci.yml	ci: Add explanation in forbidigo (#12140 )	3 years ago
CHANGELOG.md	Revert "[Docs] Agent configuration hierarchy "	3 years ago
Dockerfile	Update docker image base to alpine:3.15 (#12276 )	3 years ago
GNUmakefile	build: run mog separately after the protobufs are generated (#12665 )	3 years ago
INTERNALS.md	Move contributing to docs	3 years ago
LICENSE	Initial commit	11 years ago
NOTICE.md	add copyright notice file	6 years ago
README.md	Adjust README header to work in light and dark modes	3 years ago
Vagrantfile	Adds a basic Linux Vagrant setup, stolen from Nomad.	7 years ago
codecov.yml	Update all the references in CI and makefile to the bindata file location	4 years ago
go.mod	Add IAM Auth Method (#12583 )	3 years ago
go.sum	Bump go-control-plane	3 years ago
main.go	cmd: introduce a shim to expose Stdout/Stderr writers	4 years ago
main_test.go	Adding basic CLI infrastructure	11 years ago
package-lock.json	Adding UI screenshots to L7 overview	3 years ago

README.md

Consul

Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.

Website: https://www.consul.io
Tutorials: HashiCorp Learn
Forum: Discuss

Consul provides several key features:

Multi-Datacenter - Consul is built to be datacenter aware, and can support any number of regions without complex configuration.
Service Mesh/Service Segmentation - Consul Connect enables secure service-to-service communication with automatic TLS encryption and identity-based authorization. Applications can use sidecar proxies in a service mesh configuration to establish TLS connections for inbound and outbound connections without being aware of Connect at all.
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.

Consul runs on Linux, macOS, FreeBSD, Solaris, and Windows and includes an optional browser based UI. A commercial version called Consul Enterprise is also available.

Please note: We take Consul's security and our users' trust very seriously. If you believe you have found a security issue in Consul, please responsibly disclose by contacting us at security@hashicorp.com.

Quick Start

A few quick start guides are available on the Consul website:

Standalone binary install: https://learn.hashicorp.com/tutorials/consul/get-started-install
Minikube install: https://learn.hashicorp.com/tutorials/consul/kubernetes-minikube
Kind install: https://learn.hashicorp.com/tutorials/consul/kubernetes-kind
Kubernetes install: https://learn.hashicorp.com/tutorials/consul/kubernetes-deployment-guide

Documentation

Full, comprehensive documentation is available on the Consul website:

https://www.consul.io/docs

Contributing

Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance. For contributions specifically to the browser based UI, please refer to the UI's README.md for guidance.