Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.6 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.6 KB

consul-sidekick

Automatic peer management for Consul in Kubernetes.

consul-sidekick is designed to run as a sidecar container in each Consul pod. It obtains the list of peer pods from the Kubernetes API Server and periodically syncs the Consul pod accordingly.

Advantages:

  • Uniform deployment. All instances of Consul are deployed identically. No need to worry about the -bootstrap flag.
  • Consul instances are treated as cattle, avoiding the limitations of StatefulSets.
  • No more stale peers when pods are replaced or deleted.
  • No more bootstrapping issues. No need for an external bootstrapping service  like Atlas (now deprecated).

Install

See an example of how to use it.

Limitations

For now it assumes that the Consul pods are controlled by a ReplicaSet. However, it should be easy to extend to other controllers if needed.

Getting Help

If you have any questions about, feedback for or problems with consul-sidekick:

Your feedback is always welcome!