From: Uwe Kleine-König Date: Mon, 11 Nov 2024 16:08:17 +0000 (+0100) Subject: docs: List the same properties for all backends X-Git-Tag: dnsdist-2.0.0-alpha2~100^2~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ee8995d82d47d849a6f06184fd5e2ec011e319cc;p=thirdparty%2Fpdns.git docs: List the same properties for all backends Make all the tables at the beginning of the backend detail descriptions describe the same properties in the same order. Stick to the order used in the overview table in index.rst. Also use the more politically correct names (i.e. Master -> Primary; Slave -> Secondary; Superslave -> Autosecondary). --- diff --git a/docs/backends/bind.rst b/docs/backends/bind.rst index e4ab8a5779..0af16c246a 100644 --- a/docs/backends/bind.rst +++ b/docs/backends/bind.rst @@ -2,14 +2,18 @@ BIND zone file backend ====================== * Native: Yes -* Master: Yes -* Slave: Yes -* Superslave: Experimental +* Primary: Yes +* Secondary: Yes +* Producer: No +* Consumer: No +* Autosecondary: Experimental +* DNS Update: No * DNSSEC: Yes * Disabled data: No * Comments: No * API: Read-only -* Zone caching: Yes (except in hybrid mode) +* Multiple instances: No +* Zone caching: Yes * Module name: bind * Launch: ``bind`` diff --git a/docs/backends/generic-mysql.rst b/docs/backends/generic-mysql.rst index 778b20867a..c9edb5ecf5 100644 --- a/docs/backends/generic-mysql.rst +++ b/docs/backends/generic-mysql.rst @@ -2,12 +2,17 @@ Generic MySQL/MariaDB backend ============================== * Native: Yes -* Master: Yes -* Slave: Yes -* Superslave: Yes +* Primary: Yes +* Secondary: Yes +* Producer: Yes +* Consumer: Yes +* Autosecondary: Yes +* DNS Update: Yes * DNSSEC: Yes (set ``gmysql-dnssec``) * Disabled data: Yes * Comments: Yes +* API: Read-Write +* Multiple instances: yes * Zone caching: Yes * Module name: gmysql * Launch name: ``gmysql`` diff --git a/docs/backends/generic-odbc.rst b/docs/backends/generic-odbc.rst index 8fac98d97b..b37f5766ef 100644 --- a/docs/backends/generic-odbc.rst +++ b/docs/backends/generic-odbc.rst @@ -2,12 +2,17 @@ Generic ODBC Backend ==================== * Native: Yes -* Master: Yes -* Slave: Yes -* Superslave: Yes +* Primary: Yes +* Secondary: Yes +* Producer: Yes +* Consumer: Yes +* Autosecondary: Yes +* DNS Update: Yes * DNSSEC: Yes * Disabled data: Yes * Comments: Yes +* API: Read-Write +* Multiple instances: yes * Zone caching: Yes * Module name: godbc * Launch name: ``godbc`` diff --git a/docs/backends/generic-postgresql.rst b/docs/backends/generic-postgresql.rst index da74cd69c0..4d0d519db3 100644 --- a/docs/backends/generic-postgresql.rst +++ b/docs/backends/generic-postgresql.rst @@ -2,12 +2,17 @@ Generic PostgreSQL backend ========================== * Native: Yes -* Master: Yes -* Slave: Yes -* Superslave: Yes +* Primary: Yes +* Secondary: Yes +* Producer: Yes +* Consumer: Yes +* Autosecondary: Yes +* DNS Update: Yes * DNSSEC: Yes (set ``gpgsql-dnssec``) * Disabled data: Yes * Comments: Yes +* API: Read-Write +* Multiple instances: yes * Zone caching: Yes * Module name: gpgsql * Launch name: ``gpgsql`` diff --git a/docs/backends/generic-sqlite3.rst b/docs/backends/generic-sqlite3.rst index b6a02b1324..d12ebe3f89 100644 --- a/docs/backends/generic-sqlite3.rst +++ b/docs/backends/generic-sqlite3.rst @@ -2,12 +2,17 @@ Generic SQLite 3 backend ======================== * Native: Yes -* Master: Yes -* Slave: Yes -* Superslave: Yes +* Primary: Yes +* Secondary: Yes +* Producer: Yes +* Consumer: Yes +* Autosecondary: Yes +* DNS Update: Yes * DNSSEC: Yes * Disabled data: Yes * Comments: Yes +* API: Read-Write +* Multiple instances: yes * Zone caching: Yes * Module name: gsqlite3 * Launch name: ``gsqlite3`` diff --git a/docs/backends/geoip.rst b/docs/backends/geoip.rst index 539d16767f..551e576783 100644 --- a/docs/backends/geoip.rst +++ b/docs/backends/geoip.rst @@ -2,12 +2,17 @@ GeoIP backend ============= * Native: Yes -* Master: No -* Slave: No -* Superslave: No +* Primary: No +* Secondary: No +* Producer: No +* Consumer: No +* Autosecondary: No +* DNS Update: No * DNSSEC: Yes * Disabled data: No * Comments: No +* API: Read-only +* Multiple instances: Yes * Zone caching: Yes * Module name: geoip * Launch name: ``geoip`` diff --git a/docs/backends/ldap.rst b/docs/backends/ldap.rst index bc7616b538..9ea798e98d 100644 --- a/docs/backends/ldap.rst +++ b/docs/backends/ldap.rst @@ -2,12 +2,17 @@ LDAP backend ============ * Native: Yes -* Master: Yes -* Slave: No -* Superslave: No +* Primary: Yes +* Secondary: No +* Producer: No +* Consumer: No +* Autosecondary: No +* DNS Update: No * DNSSEC: No * Disabled data: No * Comments: No +* API: Read-only +* Multiple instances: Yes * Zone caching: No * Module name: ldap * Launch name: ``ldap`` diff --git a/docs/backends/lmdb.rst b/docs/backends/lmdb.rst index 9f5bb70a6a..c4750b8fb7 100644 --- a/docs/backends/lmdb.rst +++ b/docs/backends/lmdb.rst @@ -2,12 +2,16 @@ LMDB backend ============ * Native: Yes -* Master: Yes -* Slave: Yes -* Superslave: No +* Primary: Yes +* Secondary: Yes +* Producer: Yes +* Consumer: Yes +* Autosecondary: No +* DNS Update: No * DNSSEC: Yes * Disabled data: Yes * Comments: No +* API: Read-Write * Multiple instances: No * Zone caching: Yes * Module name: lmdb diff --git a/docs/backends/lua2.rst b/docs/backends/lua2.rst index f0793318e6..db1a74a914 100644 --- a/docs/backends/lua2.rst +++ b/docs/backends/lua2.rst @@ -2,16 +2,23 @@ Lua2 Backend ============ * Native: Yes -* Master: Yes -* Slave: No -* Superslave: No +* Primary: Yes +* Secondary: No +* Producer: No +* Consumer: No +* Autosecondary: No +* DNS Update: No * DNSSEC: Yes * Disabled data: No * Comments: No -* Zone caching: Yes +* API: Read-Write +* Multiple instances: Yes +* Zone caching: Yes\* * Module name: lua2 * Launch name: ``lua2`` +\* If provided by the responder (your script). + This is a rewrite of existing Lua backend. This backend is stub between your Lua script and PowerDNS authoritative server. The backend uses AuthLua4 base class, and you can use same functions and types as in any other Lua script. diff --git a/docs/backends/pipe.rst b/docs/backends/pipe.rst index 77bd189557..029f9cbd1c 100644 --- a/docs/backends/pipe.rst +++ b/docs/backends/pipe.rst @@ -2,12 +2,17 @@ Pipe Backend ============ * Native: Yes -* Master: No -* Slave: No -* Superslave: No -* DNSSEC: Partial, no delegation, no key storage +* Primary: No +* Secondary: No +* Producer: No +* Consumer: No +* Autosecondary: No +* DNS Update: No +* DNSSEC: No * Disabled data: No * Comments: No +* API: Read-only +* Multiple instances: Yes * Zone caching: No * Module name: pipe * Launch name: ``pipe`` diff --git a/docs/backends/random.rst b/docs/backends/random.rst index b48f215175..016c0a2c49 100644 --- a/docs/backends/random.rst +++ b/docs/backends/random.rst @@ -5,14 +5,19 @@ Random Backend This backend has been removed in 4.6.0 * Native: Yes -* Master: No -* Slave: No -* Superslave: No -* DNSSEC: Yes, no key storage +* Primary: No +* Secondary: No +* Producer: No +* Consumer: No +* Autosecondary: No +* DNS Update: No +* DNSSEC: No * Disabled data: No * Comments: No +* API: No +* Multiple instances: No * Zone caching: No -* Module name: built in +* Module name: random * Launch: ``random`` This is a very silly backend which is discussed in the :doc:`Backends diff --git a/docs/backends/remote.rst b/docs/backends/remote.rst index d2e6f62ed5..f121035a8d 100644 --- a/docs/backends/remote.rst +++ b/docs/backends/remote.rst @@ -2,12 +2,20 @@ Remote Backend ============== * Native: Yes -* Master: Yes\* -* Slave: Yes\* -* Superslave: Yes\* +* Primary: Yes\* +* Secondary: Yes\* +* Producer: No +* Consumer: No +* Autosecondary: Yes\* +* DNS Update: No * DNSSEC: Yes\* -* Zone caching: Yes\* +* Disabled data: No +* Comments: No +* API: Read-Write * Multiple instances: Yes +* Zone caching: Yes\* +* Module name: remote +* Launch: ``remote`` \* If provided by the responder (your script). diff --git a/docs/backends/tinydns.rst b/docs/backends/tinydns.rst index fa9b07fe6b..5d2f27ccd7 100644 --- a/docs/backends/tinydns.rst +++ b/docs/backends/tinydns.rst @@ -2,12 +2,18 @@ TinyDNS Backend =============== * Native: Yes -* Master: Yes -* Slave: No -* Superslave: No +* Primary: Yes +* Secondary: No +* Producer: No +* Consumer: No +* Autosecondary: No +* DNS Update: No * DNSSEC: No -* Zone caching: Yes +* Disabled data: No +* Comments: No +* API: Read-only * Multiple Instances: Yes +* Zone caching: Yes * Module name: tinydns * Launch: ``tinydns``