dnsdist: add RedisKVStore docs

Signed-off-by: Ensar Sarajčić <dev@ensarsarajcic.com>

Author: esensar

.github/actions/spell-check/expect.txt

@@ -561,6 +561,7 @@ Hendriks
 Henk
 Hensbergen
 Heuer
+hexists
 HHIT
 hidesoadetails
 hidettl

pdns/dnsdistdist/docs/reference/actions.rst

@@ -139,7 +139,7 @@ The following actions exist.
 
   Does a lookup into the key value store referenced by 'kvs' using the key returned by 'lookupKey',
   and storing the result if any into the tag named 'destinationTag'.
-  The store can be a CDB (:func:`newCDBKVStore`), a LMDB database (:func:`newLMDBKVStore`), or a MMDB database (:func: `newMMDBKVStore`).
+  The store can be a CDB (:func:`newCDBKVStore`), a LMDB database (:func:`newLMDBKVStore`), a MMDB database (:func: `newMMDBKVStore`), or a Redis instance (:func:`newRedisKVStore`).
   The key can be based on the qname (:func:`KeyValueLookupKeyQName` and :func:`KeyValueLookupKeySuffix`),
   source IP (:func:`KeyValueLookupKeySourceIP`) or the value of an existing tag (:func:`KeyValueLookupKeyTag`).
   Subsequent rules are processed after this action.

pdns/dnsdistdist/docs/reference/config.rst

@@ -2573,6 +2573,52 @@ MMDB
 
    * ``mmap``: bool - If set to true, opens the database in memory-map mode.
 
+Redis
+~~~~~
+
+.. class:: RedisClient
+
+  .. versionadded:: 2.2.0
+
+  .. method:: get(key)
+
+    Returns the (string) value of a key in Redis, if it exists (GET command).
+
+    :param str key: Key to look up.
+    :returns: The string value.
+
+  .. method:: exists(key)
+
+    Checks if the given key exists in Redis (EXISTS command).
+
+    :param str key: Key to look up.
+    :returns: true if the key exists, false otherwise.
+
+  .. method:: hget(hash_key, key)
+
+    Returns the value of a field in the hash stored at hash_key in Redis, if it exists (HGET command).
+
+    :param str hash_key: Key the hash is stored at.
+    :param str key: Field in hash to look up.
+    :returns: The string value.
+
+  .. method:: hexists(hash_key, key)
+
+    Checks if the given field exists in hash stored at hash_key in Redis (HEXISTS command).
+
+    :param str hash_key: Key the hash is stored at.
+    :param str key: Field in hash to look up.
+    :returns: true if the field exists, false otherwise.
+
+.. function:: newRedisClient(url)
+
+  .. versionadded:: 2.2.0
+
+  Creates a new Redis client, connecting to the instance at the provided url.
+
+  :param string url: URL to the Redis instance.
+  :returns:  The :class:`RedisClient` object
+
 timespec
 ~~~~~~~~
 

pdns/dnsdistdist/docs/reference/kvs.rst

@@ -12,6 +12,7 @@ The first step is to get a :class:`KeyValueStore` object via one of the followin
  * :func:`newCDBKVStore` for a CDB database ;
  * :func:`newLMDBKVStore` for a LMDB one.
  * :func:`newMMDBKVStore` for a MMDB one.
+ * :func:`newRedisKVStore` for a Redis client.
 
 Then the key used for the lookup can be selected via one of the following functions:
 
@@ -136,3 +137,22 @@ If the value found in the LMDB database for the key '\\8powerdns\\3com\\0' was '
 
   :param MMDB mmdb: The reference to an existing MMDB database created with :func:`openMMDB`.
   :param str-or-list queryParams: Key or list of keys to fetch from the retrieved object from the MMDB database. Use empty list to retrieve the whole object.
+
+.. function:: newRedisKVStore(redis[, options]) -> KeyValueStore
+
+  .. versionadded:: 2.2.0
+
+  Return a new KeyValueStore object associated to the provided Redis client. The client can be created using :func:`newRedisClient`.
+
+  :param RedisClient redis: The reference to an existing Redis client created with :func:`newRedisClient`.
+  :param table options: A table with key: value pairs with options.
+
+  Options:
+
+  * ``lookupAction``: str - Command to use when looking up keys in Redis. Check below for supported lookup actions.
+  * ``dataName``: str - Additional value with different behavior depending on the lookup action.
+
+  Lookup actions:
+
+  * ``get``: str - The default lookup action. Uses Redis GET command to look up keys. ``dataName`` can be used to define a prefix to be added to all keys before looking up.
+  * ``hget``: str - Uses Redis HGET command to look up keys as fields of a hash. ``dataName`` is required for this action and defines the key hash is stored at.

pdns/dnsdistdist/docs/reference/selectors.rst

@@ -81,7 +81,7 @@ Selectors can be combined via :func:`AndRule`, :func:`OrRule` and :func:`NotRule
 .. function:: KeyValueStoreLookupRule(kvs, lookupKey)
 
   Return true if the key returned by 'lookupKey' exists in the key value store referenced by 'kvs'.
-  The store can be a CDB (:func:`newCDBKVStore`), a LMDB database (:func:`newLMDBKVStore`), or a MMDB database (:func: `newMMDBKVStore`).
+  The store can be a CDB (:func:`newCDBKVStore`), a LMDB database (:func:`newLMDBKVStore`), a MMDB database (:func: `newMMDBKVStore`), or a Redis instance (:func:`newRedisKVStore`).
   The key can be based on the qname (:func:`KeyValueLookupKeyQName` and :func:`KeyValueLookupKeySuffix`),
   source IP (:func:`KeyValueLookupKeySourceIP`) or the value of an existing tag (:func:`KeyValueLookupKeyTag`).