diff --git a/mod/README.md b/mod/README.md new file mode 100644 index 000000000..5fd9c1782 --- /dev/null +++ b/mod/README.md @@ -0,0 +1,10 @@ +## Etcd modules + +etcd modules (mods) are higher order pieces of functionality that only +speak to the client etcd API and are presented in the `/mod` HTTP path +of the etcd service. + +The basic idea is that etcd can ship things like dashboards, master +election APIs and other helpful services that would normally have to +stand up and talk to an etcd cluster directly in the binary. It is a +convienence and hopefully eases complexity in deployments.