From 5e382fed04beddd6cf7f4e7713b3a6782cce0d23 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Petr=20=C5=A0pa=C4=8Dek?= Date: Mon, 6 Jan 2020 18:54:52 +0100 Subject: [PATCH] doc: move etcd module into Run-time reconfiguration section --- daemon/scripting.rst | 2 ++ doc/config.rst | 1 - modules/etcd/README.rst | 24 ++++++++++++------------ 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/daemon/scripting.rst b/daemon/scripting.rst index b878ec184..543f7ce47 100644 --- a/daemon/scripting.rst +++ b/daemon/scripting.rst @@ -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/ diff --git a/doc/config.rst b/doc/config.rst index 1fb225511..7b79504fc 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -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 ===================== diff --git a/modules/etcd/README.rst b/modules/etcd/README.rst index 5de55c216..9354a7136 100644 --- a/modules/etcd/README.rst +++ b/modules/etcd/README.rst @@ -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 `_. +The `etcd` module connects to `etcd `_ 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 `_. 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 `_ available in LuaRocks +* `lua-etcd `_ library available in LuaRocks ``$ luarocks install etcd --from=https://mah0x211.github.io/rocks/`` -- 2.47.2