Commit Graph
230 Commits
Author SHA1 Message Date
Mark Andrews da6359345e Add check-svcb to named
check-svcb signals whether to perform additional contraint tests
when loading / update primary zone files.
2022-10-29 00:22:54 +11:00
Aram Sargsyan ef344b1f52 Fix prefetch "trigger" value's documentation in ARM
For the prefetch "trigger" parameter ARM states that when a cache
record with a lower TTL value is encountered during query processing,
it is refreshed. But in reality, the record is refreshed when the TTL
value is lower or equal to the configured "trigger" value.

Fix the documentation to make it match with with the code.
2022-10-21 10:19:53 +00:00
Petr Špaček 137e0f4e0e Remove manually defined anchors pointing to statement definitions
This is hopefully end of duplication. This batch did not cause clashes
in Sphinx but it was pointless nonetheless as we have auto-generated
anchors for all statements.
2022-10-05 11:36:22 +02:00
Tom KrizekandPetr Špaček ea2d213f34 Remove trailing whitespaces 2022-10-05 11:36:22 +02:00
Petr Špaček 9a7c2b370e Deduplicate link anchors in the ARM
Some statement names like "allow-query" had manually defined link anchor
_allow-query and also implicit anchor created by
.. namedconf:statement:: syntax. This causes warnings if a ambiguous
reference is made using :any:`allow-query` syntax.

Remove (hopefully all) manually defined anchors which pointed to
identical place as the implicit anchor. This allows :any: to work.

In rare cases where manual anchor points to descriptive text separated
from statement definition the reference was disamguated by replacing
:any:`notify` with :ref:`notify` (for manual anchor)
vs. :namedconf:ref:`notify` (for statement definition).

Please note that `options` statement is a trap: It is ambiguous even
without manual anchor because rndc.conf has its own `options`. Use
:namedconf:ref:`options` vs. :rndcconf:ref:`options` to select
appropriate target.
2022-10-05 11:36:19 +02:00
Matthijs Mekking 5d454a7158 Update inline-signing requirement to ARM
This change was made in !6403, but the appropriate documentation
changes were not applied to the ARM.
2022-09-27 17:06:30 +02:00
Petr MenšíkandPetr Špaček bc6c6b1184 Compatibility for building ARM on older sphinx
Make documentation building successful even on RHEL9 sphinx 3.4.3. It
does not like case-insensitive matching of terms, so provide lowercase
text description with Uppercase word reference.
2022-09-26 17:09:51 +02:00
Ondřej Surý 6869c98d36 Provide stronger wording about the security of statistics channel
Add more text about the importance of properly securing the statistics
channel and what is and what is not considered a security vulnerability.
2022-09-15 10:29:38 +02:00
Evan Hunt 9730f21f83 flag "random-device" as ancient
the "random-device" option was made non-functional in 9.13. this commit
removes it from the configuration parser; setting it is now an error.
2022-09-14 09:36:58 -07:00
Mark Andrews 7751e5e039 Add server clause require-cookie
Specifies if an UDP response requires a DNS COOKIE or not.
Fallback to TCP if not present and not TSIG signed.
2022-09-13 12:07:13 +10:00
Aram SargsyanandMichał Kępień 89c2032421 Document RRL processing for wildcard names
All valid wildcard domain names are interpreted as the zone's origin
name concatenated to the "*" name.
2022-09-08 09:15:30 +02:00
Aram Sargsyan 7eda1aba76 Document RPZ Extended DNS Error (EDE) code configuration option
Add information about the 'ede' option for response policy zones.
2022-08-31 08:56:03 +00:00
Petr Špaček 9b3710987b Add last missing tags, finishing touches 2022-07-29 18:56:04 +02:00
Suzanne GoldlustandPetr Špaček f9a5f389ed Add descriptions of each tag 2022-07-29 18:56:04 +02:00
Suzanne GoldlustandPetr Špaček 20d01ca2e3 Text edits to Statements and Statements by Tag sections 2022-07-29 18:56:04 +02:00
Suzanne GoldlustandPetr Špaček e14201a2f6 Reorder Statements and Statements by Tag sections 2022-07-29 18:56:04 +02:00
Suzanne GoldlustandPetr Špaček fc272863c6 Rephrase parental-agents description 2022-07-29 18:56:04 +02:00
Suzanne GoldlustandPetr Špaček a470a6545f Add short descriptions and some tags to statements through line 1766 2022-07-29 18:56:00 +02:00
Evan Hunt b1d0cac280 Forbid zones with both dnssec-policy and max-zone-ttl
Since max-zone-ttl in zone/view/options is a no-op if dnssec-policy
is in use, let's make that a fatal error.
2022-07-20 11:57:37 -07:00
Evan Hunt 19352dd187 mark max-zone-ttl deprecated in options and zone
The "max-zone-ttl" option should now be configured as part of
"dnssec-policy". The option with the same name in "zone" and
"options" is hereby flagged as deprecated, and its functionality
will be removed in a future release.
2022-07-20 11:55:03 -07:00
Greg ChoulesandPetr Špaček 4d21939e99 Document qname-minimization off equals disabled 2022-07-18 18:22:01 +02:00
Suzanne GoldlustandPetr Špaček bb2bce539f Fix http block short description 2022-07-18 18:21:42 +02:00
Suzanne GoldlustandPetr Špaček 762359788b Add headings for server, logging, zone, and view statements 2022-07-18 18:16:33 +02:00
Suzanne GoldlustandPetr Špaček 7c5a0ec540 Add tags/short descriptions for the "view" category 2022-07-18 18:16:33 +02:00
Suzanne GoldlustandPetr Špaček cc2e144371 Add tags/short descriptions for "zone" category 2022-07-18 18:16:33 +02:00
Suzanne GoldlustandPetr Špaček 51a41ec7ef Add tags/short descriptions for "logging" category 2022-07-18 18:10:44 +02:00
Suzanne GoldlustandPetr Špaček 3ab858d828 Add tags and short descriptions for tag "server" 2022-07-18 18:10:44 +02:00
Petr Špaček c3fed5ce40 Manually hyperlink algorithm, key, options, secret, and server
These statements/block are ambiguos because they occur in named.conf and
rndc.conf as well. All occurences now link link to the matching
definition.
2022-07-04 15:50:52 +02:00
Suzanne GoldlustandPetr Špaček 6db988e7e3 Grammar fixes and assorted text edits in the ARM 2022-07-04 15:50:51 +02:00
Petr Špaček dd4dc78899 Add tables with statements by tag 2022-07-04 15:50:51 +02:00
Petr Špaček f91cbcf996 Define topmost configuration blocks 2022-07-04 15:50:51 +02:00
Petr Špaček 8aea6694bf Alphabetize grammar glossary 2022-07-04 15:50:51 +02:00
Petr Špaček 0138e5c1d5 Rename yes_or_no to boolean
The name yes_or_no was used only in two places and rest of the ARM
(except for the grammar glossary...) uses term boolean. Let's stick to
it.
2022-07-04 15:50:51 +02:00
Petr Špaček decb4643d1 Deduplicate definitions of address_match_list and address_match_element
It would be better if it fit into the grammar glossary, but it is too
long. A link must do.
2022-07-04 15:50:51 +02:00
Petr Špaček 4915b1f3a1 Rework size_spec and size_or_percentage definitions
Except for a single case they were not referenced in the text, but at
the same time doc/misc grammar uses terms "size", "sizeval", and
"percetage".

Keywords "default" and "unlimited" are expanded in statement's grammar
anyway, but I kept their description in place because they are generally
allowed at places which accept sizes.

Percentage is also expanded in doc/misc grammars and thus requires
separate definition.
2022-07-04 15:50:51 +02:00
Petr Špaček 1233c86ff7 Remove incorrect hyperlinks to file and unix definitions
Terms file and unix have overloaded meaning and were incorrectly linked
during the mass-linking campain.
2022-07-04 15:50:51 +02:00
Petr Špaček 8d9c2368a9 Rename port_list to portrange
The old name was not referenced anywhere but the new name is used in
grammar of {avoid,use}-v{4,6}-udp-ports statement.
2022-07-04 15:50:51 +02:00
Petr Špaček 443fb5f34b Remove path_name grammar definition
It was literally not used anywhere.
2022-07-04 15:50:51 +02:00
Petr Špaček 55bc6d02a0 Hyperlink integer to its definition 2022-07-04 15:50:51 +02:00
Petr Špaček 9885bf658d Rename number to integer
The term number was used only in other definitions, and at the same time
doc/misc grammar uses term integer.
2022-07-04 15:50:51 +02:00
Petr Špaček 6f754dae20 Clarify and hyperlink tls_id definition 2022-07-04 15:50:51 +02:00
Petr Špaček 116573a4a7 Hyperlink server_id to its definition 2022-07-04 15:50:51 +02:00
Petr Špaček c972fad7b0 Rename key_id to server_key
The old name was used in the ARM and rndc manual page but was
inconsistent with doc/misc grammar.
2022-07-04 15:50:51 +02:00
Petr Špaček 818219b36a Remove key_list grammar definition
It was used in a single place (inet statement) and it defined it in the
text anyway. Let's not clutter the glossary.
2022-07-04 15:50:50 +02:00
Petr Špaček 686a15d30f Hyperlink port references to appropriate definitions
``port`` used to refer to grammar elements and also to named.conf
option. Both cases are now linked to respective definitions.
2022-07-04 15:50:50 +02:00
Petr Špaček 7b51a027e7 Rename ip_port to port
The old name was used only in couple places, and was inconsistent with
doc/misc grammar.
2022-07-04 15:50:50 +02:00
Petr Špaček d1644f420c Rename ip_dscp to dscp
The old name was literally not used anywhere, not even in the source
code. The new name is used by doc/misc grammar.
2022-07-04 15:50:50 +02:00
Petr Špaček 5ce45d1c04 Hyperlink netprefix grammar references to the definition 2022-07-04 15:50:50 +02:00
Petr Špaček a35c1ae0c2 Hyperlink ip??_address grammar references to their definition 2022-07-04 15:50:50 +02:00
Petr Špaček b22bdb3a1b Rename ip_prefix to netprefix
Let's standardize on netprefix which matches grammar used in doc/misc.
2022-07-04 15:50:50 +02:00