Skip to content

Commit

Permalink
docs: List the same properties for all backends
Browse files Browse the repository at this point in the history
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).
  • Loading branch information
ukleinek committed Jan 31, 2025
1 parent 592956f commit d183207
Show file tree
Hide file tree
Showing 13 changed files with 114 additions and 47 deletions.
12 changes: 8 additions & 4 deletions docs/backends/bind.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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: Yes
* 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``

Expand Down
11 changes: 8 additions & 3 deletions docs/backends/generic-mysql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
11 changes: 8 additions & 3 deletions docs/backends/generic-odbc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
11 changes: 8 additions & 3 deletions docs/backends/generic-postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
11 changes: 8 additions & 3 deletions docs/backends/generic-sqlite3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
13 changes: 9 additions & 4 deletions docs/backends/geoip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@ 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
* Zone caching: Yes
* API: Read-only
* Multiple instances: Yes
* Zone caching: No
* Module name: geoip
* Launch name: ``geoip``

Expand Down
11 changes: 8 additions & 3 deletions docs/backends/ldap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
10 changes: 7 additions & 3 deletions docs/backends/lmdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 9 additions & 4 deletions docs/backends/lua2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@ 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: No
* Module name: lua2
* Launch name: ``lua2``

Expand Down
13 changes: 9 additions & 4 deletions docs/backends/pipe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
15 changes: 10 additions & 5 deletions docs/backends/random.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 12 additions & 4 deletions docs/backends/remote.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
14 changes: 10 additions & 4 deletions docs/backends/tinydns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``

Expand Down

0 comments on commit d183207

Please sign in to comment.