]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: move etcd module into Run-time reconfiguration section
authorPetr Špaček <petr.spacek@nic.cz>
Mon, 6 Jan 2020 17:54:52 +0000 (18:54 +0100)
committerTomas Krizek <tomas.krizek@nic.cz>
Wed, 15 Jan 2020 09:38:17 +0000 (10:38 +0100)
daemon/scripting.rst
doc/config.rst
modules/etcd/README.rst

index b878ec184e44cc3d0731312e5e5005d75030951c..543f7ce4757ad84816ea8854cbdeb86ec422586b 100644 (file)
@@ -284,6 +284,8 @@ Filesystem watchers are possible with :func:`worker.coroutine()` and cqueues_, s
 
 .. include:: ../daemon/bindings/event.rst
 
+.. include:: ../modules/etcd/README.rst
+
 .. _closures: https://www.lua.org/pil/6.1.html
 .. _cqueues: https://25thandclement.com/~william/projects/cqueues.html
 .. _LuaRocks: https://luarocks.org/
index 1fb2255114858e71e0420f2e53106b5fd278aaea..7b79504fcee20ebf0368603fce0f20b0ecb606e2 100644 (file)
@@ -175,7 +175,6 @@ TODO: Other
 .. include:: ../modules/http/README.rst
 .. include:: ../modules/http/README.doh.rst
 .. include:: ../modules/daf/README.rst
-.. include:: ../modules/etcd/README.rst
 
 Experimental features
 =====================
index 5de55c216a13ca9895a00b93dfeead1e786f62e6..9354a7136a4ca7eb44ebafd64335e9a9fb0b63b2 100644 (file)
@@ -1,11 +1,12 @@
 .. _mod-etcd:
 
-Etcd module
------------
+Etcd support
+------------
 
-The module connects to Etcd peers and watches for configuration change.
-By default, the module looks for the subtree under ``/knot-resolver`` directory,
-but you can change this `in the configuration <https://github.com/mah0x211/lua-etcd#cli-err--etcdnew-optiontable->`_.
+The `etcd` module connects to `etcd <https://etcd.io/>`_ peers and watches
+for configuration changes. By default, the module watches the subtree under
+``/knot-resolver`` directory, but you can change this in the
+`etcd library configuration <https://github.com/mah0x211/lua-etcd#cli-err--etcdnew-optiontable->`_.
 
 The subtree structure corresponds to the configuration variables in the declarative style.
 
@@ -26,19 +27,18 @@ Example configuration
 
 .. code-block:: lua
 
-       modules = {
-               etcd = {
-                       prefix = '/knot-resolver',
-                       peer = 'http://127.0.0.1:7001'
-               }
-       }
+       modules.load('etcd')
+        etcd.config({
+                prefix = '/knot-resolver',
+                peer = 'http://127.0.0.1:7001'
+        })
 
 .. warning:: Work in progress!
 
 Dependencies
 ^^^^^^^^^^^^
 
-* `lua-etcd <https://github.com/mah0x211/lua-etcd>`_ available in LuaRocks
+* `lua-etcd <https://github.com/mah0x211/lua-etcd>`_ library available in LuaRocks
 
     ``$ luarocks install etcd --from=https://mah0x211.github.io/rocks/``