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) and consistently use * instead
of - for the list.
  • Loading branch information
ukleinek committed Nov 11, 2024
1 parent 98128bb commit 7463ded
Show file tree
Hide file tree
Showing 13 changed files with 141 additions and 54 deletions.
12 changes: 9 additions & 3 deletions docs/backends/bind.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@ BIND zone file backend
======================

* Native: Yes
* Master: Yes
* Slave: Yes
* Superslave: Experimental
* Primary: Yes
* Secondary: Yes
* Producer: Yes
* Consumer: Yes
* Autoprimary: Yes
* Autosecondary: Yes
* Case: ???
* DNS Update: No
* DNSSEC: Yes
* Disabled data: No
* Comments: No
* API: Read-only
* Multiple instances: ???
* Zone caching: Yes (except in hybrid mode)
* Module name: bind
* Launch: ``bind``
Expand Down
12 changes: 9 additions & 3 deletions docs/backends/generic-mysql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@ Generic MySQL/MariaDB backend
==============================

* Native: Yes
* Master: Yes
* Slave: Yes
* Superslave: Yes
* Primary: Yes
* Secondary: Yes
* Producer: Yes
* Consumer: Yes
* Autoprimary: Yes
* Autosecondary: Yes
* Case: All lower
* 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
12 changes: 9 additions & 3 deletions docs/backends/generic-odbc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@ Generic ODBC Backend
====================

* Native: Yes
* Master: Yes
* Slave: Yes
* Superslave: Yes
* Primary: Yes
* Secondary: Yes
* Producer: Yes
* Consumer: Yes
* Autoprimary: Yes
* Autosecondary: Yes
* Case: All lower
* 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
12 changes: 9 additions & 3 deletions docs/backends/generic-postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@ Generic PostgreSQL backend
==========================

* Native: Yes
* Master: Yes
* Slave: Yes
* Superslave: Yes
* Primary: Yes
* Secondary: Yes
* Producer: Yes
* Consumer: Yes
* Autoprimary: Yes
* Autosecondary: Yes
* Case: All lower
* 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
13 changes: 10 additions & 3 deletions docs/backends/generic-sqlite3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@ Generic SQLite 3 backend
========================

* Native: Yes
* Master: Yes
* Slave: Yes
* Superslave: Yes
* Primary: Yes
* Secondary: Yes
* Producer: Yes
* Consumer: Yes
* Autoprimary: Yes
* Autosecondary: Yes
* Case: ???
* 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: 10 additions & 3 deletions docs/backends/geoip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@ GeoIP backend
=============

* Native: Yes
* Master: No
* Slave: No
* Superslave: No
* Primary: No
* Secondary: No
* Producer: No
* Consumer: No
* Autoprimary: No
* Autosecondary: No
* Case: ???
* DNS Update: No
* DNSSEC: Yes
* Disabled data: No
* Comments: No
* API: ???
* Multiple instances: ???
* Zone caching: Yes
* Module name: geoip
* Launch name: ``geoip``
Expand Down
13 changes: 10 additions & 3 deletions docs/backends/ldap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@ LDAP backend
============

* Native: Yes
* Master: Yes
* Slave: No
* Superslave: No
* Primary: Yes
* Secondary: No
* Producer: No
* Consumer: No
* Autoprimary: No
* Autosecondary: No
* Case: ???
* DNS Update: No
* DNSSEC: No
* Disabled data: No
* Comments: No
* API: ???
* Multiple instances: ???
* Zone caching: No
* Module name: ldap
* Launch name: ``ldap``
Expand Down
11 changes: 8 additions & 3 deletions docs/backends/lmdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@ LMDB backend
============

* Native: Yes
* Master: Yes
* Slave: Yes
* Superslave: No
* Primary: Yes
* Secondary: Yes
* Producer: Yes
* Consumer: Yes
* Autoprimary: No
* Autosecondary: No
* Case: All lower
* DNS Update: No
* DNSSEC: Yes
* Disabled data: Yes
* Comments: No
* API: ???
* Multiple instances: No
* Zone caching: Yes
* Module name: lmdb
Expand Down
13 changes: 10 additions & 3 deletions docs/backends/lua2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@ Lua2 Backend
============

* Native: Yes
* Master: Yes
* Slave: No
* Superslave: No
* Primary: Yes
* Secondary: No
* Producer: No
* Consumer: No
* Autoprimary: No
* Autosecondary: No
* Case: ???
* DNS Update: No
* DNSSEC: Yes
* Disabled data: No
* Comments: No
* API: ???
* Multiple instances: ???
* Zone caching: Yes
* Module name: lua2
* Launch name: ``lua2``
Expand Down
12 changes: 9 additions & 3 deletions docs/backends/pipe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@ Pipe Backend
============

* Native: Yes
* Master: No
* Slave: No
* Superslave: No
* Primary: No
* Secondary: No
* Producer: No
* Consumer: No
* Autoprimary: No
* Autosecondary: No
* Case: Depends
* DNS Update: No
* DNSSEC: Partial, no delegation, no key storage
* Disabled data: No
* Comments: No
* API: ???
* Multiple instances: ???
* Zone caching: No
* Module name: pipe
* Launch name: ``pipe``
Expand Down
28 changes: 17 additions & 11 deletions docs/backends/random.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,23 @@ Random Backend
.. deprecated:: 4.6.0
This backend has been removed in 4.6.0

- Native: Yes
- Master: No
- Slave: No
- Superslave: No
- Case: Depends
- DNSSEC: Yes, no key storage
- Disabled data: No
- Comments: No
- Zone caching: No
- Module name: built in
- Launch: ``random``
* Native: Yes
* Primary: No
* Secondary: No
* Producer: No
* Consumer: No
* Autoprimary: No
* Autosecondary: No
* Case: Depends
* DNS Update: No
* DNSSEC: Yes, no key storage
* Disabled data: No
* Comments: No
* API: ???
* Multiple instances: ???
* Zone caching: No
* Module name: built in
* Launch: ``random``

This is a very silly backend which is discussed in the :doc:`Backends
writer's guide <../appendices/backend-writers-guide>`.
Expand Down
18 changes: 14 additions & 4 deletions docs/backends/remote.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,22 @@ Remote Backend
==============

* Native: Yes
* Master: Yes\*
* Slave: Yes\*
* Superslave: Yes\*
* Primary: Yes\*
* Secondary: Yes\*
* Producer: No
* Consumer: No
* Autoprimary: Yes\*
* Autosecondary: Yes\*
* Case: ???
* DNS Update: No
* DNSSEC: Yes\*
* Zone caching: Yes\*
* Disabled data: No
* Comments: No
* API: ???
* Multiple instances: Yes
* Zone caching: Yes\*
* Module name: remote
* Launch: ``remote``

\* If provided by the responder (your script).

Expand Down
26 changes: 17 additions & 9 deletions docs/backends/tinydns.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
TinyDNS Backend
===============

- Native: Yes
- Master: Yes
- Slave: No
- Superslave: No
- DNSSEC: No
- Zone caching: Yes
- Multiple Instances: Yes
- Module name: tinydns
- Launch: ``tinydns``
* Native: Yes
* Primary: Yes
* Secondary: No
* Producer: No
* Consumer: No
* Autoprimary: No
* Autosecondary: No
* Case: ???
* DNS Update: No
* DNSSEC: No
* Disabled data: ???
* Comments: ???
* API: ???
* Multiple Instances: Yes
* Zone caching: Yes
* Module name: tinydns
* Launch: ``tinydns``

The TinyDNS backend allows you to use
`djbdns's <http://cr.yp.to/djbdns.html>`__ ``data.cdb`` file format as
Expand Down

0 comments on commit 7463ded

Please sign in to comment.