From a993a4689b4119f80bf4e9eac0836793f625882f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Petr=20=C5=A0pa=C4=8Dek?= Date: Fri, 3 Jan 2020 20:28:29 +0100 Subject: [PATCH] doc: nsid module polish for new docs structure --- modules/nsid/README.rst | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/modules/nsid/README.rst b/modules/nsid/README.rst index 3ac4c00b4..ec967d765 100644 --- a/modules/nsid/README.rst +++ b/modules/nsid/README.rst @@ -3,16 +3,11 @@ Name Server Identifier (NSID) ----------------------------- -This module provides server-side support for :rfc:`5001` -and is not enabled by default. - -DNS clients can request resolver to send back its NSID along with the reply -to a DNS request. This is useful for identification of resolver instances -in larger services (using anycast or load balancers). - - -This is useful tool for debugging larger services, -as it reveals which particular resolver instance sent the reply. +Module ``nsid`` provides server-side support for :rfc:`5001` +which allows DNS clients to request resolver to send back its NSID +along with the reply to a DNS request. +This is useful for debugging larger resolver farms +(e.g. when using `multiple instances`_, anycast or load balancers). NSID value can be configured in the resolver's configuration file: @@ -21,15 +16,15 @@ NSID value can be configured in the resolver's configuration file: modules.load('nsid') nsid.name('instance 1') -.. tip:: When dealing with multiple kresd instances managed with - systemd, see :ref:`instance-specific-configuration`. +.. tip:: When dealing with Knot Resolver running in `multiple instances` + managed with systemd see :ref:`instance-specific-configuration`. You can also obtain configured NSID value: .. code-block:: lua - nsid.name() - instance 1 + > nsid.name() + 'instance 1' The module can be disabled at run-time: -- 2.47.2