From c8ea1f7ca78dc9389864ece3354fe0e32ebf11ef Mon Sep 17 00:00:00 2001 From: Charles-Henri Bruyand Date: Wed, 14 Nov 2018 15:51:54 +0100 Subject: [PATCH] dnsdist: fix documentation nits and add completion documentation for showServers new options --- pdns/dnsdist-console.cc | 2 +- pdns/dnsdistdist/docs/guides/serverselection.rst | 2 +- pdns/dnsdistdist/docs/reference/config.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pdns/dnsdist-console.cc b/pdns/dnsdist-console.cc index 10f1e91918..654520cdc4 100644 --- a/pdns/dnsdist-console.cc +++ b/pdns/dnsdist-console.cc @@ -464,7 +464,7 @@ const std::vector g_consoleKeywords{ { "showRules", true, "[{showUUIDs=false, truncateRuleWidth=-1}]", "show all defined rules, optionally with their UUIDs and optionally truncated to a given width" }, { "showSelfAnsweredResponseRules", true, "[{showUUIDs=false, truncateRuleWidth=-1}]", "show all defined self-answered response rules, optionally with their UUIDs and optionally truncated to a given width" }, { "showServerPolicy", true, "", "show name of currently operational server selection policy" }, - { "showServers", true, "", "output all servers" }, + { "showServers", true, "[{showUUIDs=false}]", "output all servers, optionally with their UUIDs" }, { "showTCPStats", true, "", "show some statistics regarding TCP" }, { "showTLSContexts", true, "", "list all the available TLS contexts" }, { "showVersion", true, "", "show the current version" }, diff --git a/pdns/dnsdistdist/docs/guides/serverselection.rst b/pdns/dnsdistdist/docs/guides/serverselection.rst index c8cde68b57..191b934d69 100644 --- a/pdns/dnsdistdist/docs/guides/serverselection.rst +++ b/pdns/dnsdistdist/docs/guides/serverselection.rst @@ -48,7 +48,7 @@ The current hash algorithm is based on the qname of the query. ``chashed`` is a consistent hashing distribution policy. Identical questions with identical hashes will be distributed to the same servers. But unlike the ``whashed`` policy, this distribution will keep consistent over time. Adding or removing servers will only remap a small part of the queries. -You can also set the hash perturbation value, see :func:`setWHashedPertubation`. To achieve consistent distribution over :program:`dnsdist` restarts, you will also need to explicitly set the backend's UUIDs with the ``id`` option of :func:`newServer`. You can get the current UUIDs of your backends by calling :func:`showServers`. +You can also set the hash perturbation value, see :func:`setWHashedPertubation`. To achieve consistent distribution over :program:`dnsdist` restarts, you will also need to explicitly set the backend's UUIDs with the ``id`` option of :func:`newServer`. You can get the current UUIDs of your backends by calling :func:`showServers` with the ``showUUIDs=true`` option. ``roundrobin`` ~~~~~~~~~~~~~~ diff --git a/pdns/dnsdistdist/docs/reference/config.rst b/pdns/dnsdistdist/docs/reference/config.rst index 103d45e182..b7faaa515a 100644 --- a/pdns/dnsdistdist/docs/reference/config.rst +++ b/pdns/dnsdistdist/docs/reference/config.rst @@ -321,7 +321,7 @@ Servers newServer({ address="IP:PORT", -- IP and PORT of the backend server (mandatory) - id=STRING -- Use a pre-defined UUID instead of a random one + id=STRING, -- Use a pre-defined UUID instead of a random one qps=NUM, -- Limit the number of queries per second to NUM, when using the `firstAvailable` policy order=NUM, -- The order of this server, used by the `leastOustanding` and `firstAvailable` policies weight=NUM, -- The weight of this server, used by the `wrandom`, `whashed` and `chashed` policies, default: 1 -- 2.47.2