Commit graph

229 commits

Author SHA1 Message Date
Evan Hunt
5fa4aa2fec mark "port" as deprecated for source address options
Deprecate the use of "port" when configuring query-source(-v6),
transfer-source(-v6), notify-source(-v6), parental-source(-v6),
etc. Also deprecate use-{v4,v6}-udp-ports and avoid-{v4,v6}udp-ports.

(cherry picked from commit 470ccbc8ed)
2023-02-02 12:21:08 +01:00
Evan Hunt
3d2033bb89 add a configuration option for the update quota
add an "update-quota" option to configure the update quota.

(cherry picked from commit f57758a730)
2023-01-12 12:02:35 +01:00
Evan Hunt
9f1ebd25f6 add an update quota
limit the number of simultaneous DNS UPDATE events that can be
processed by adding a quota for update and update forwarding.
this quota currently, arbitrarily, defaults to 100.

also add a statistics counter to record when the update quota
has been exceeded.

(cherry picked from commit 7c47254a14)
2023-01-12 12:02:35 +01:00
Evan Hunt
5fd93c66aa remove nonfunctional DSCP implementation
DSCP has not been fully working since the network manager was
introduced in 9.16, and has been completely broken since 9.18.
This seems to have caused very few difficulties for anyone,
so we have now marked it as obsolete and removed the
implementation.

To ensure that old config files don't fail, the code to parse
dscp key-value pairs is still present, but a warning is logged
that the feature is obsolete and should not be used. Nothing is
done with configured values, and there is no longer any
range checking.

(cherry picked from commit 916ea26ead)
2023-01-09 14:23:26 -08:00
Matthijs Mekking
7694e5019c Document NS queries are excempt from minimal-responses
Also document that DNSKEY, DS, CDNSKEY, and CDS never do additional
section processing.

(cherry picked from commit f7b477f6ea)
2022-12-07 12:06:43 +01:00
Matthijs Mekking
132387b658 Add missing deprecated tag to max-zone-ttl
This option was deprecated in commit 19352dd187 but at that time
we didn't mark it deprecated in the ARM reference.

(cherry picked from commit 13a16c1f4d)
2022-12-01 08:14:49 +01:00
Matthijs Mekking
b4429660da Deprecate alt-transfer-source and companions
Deprecate the alternate transfer sources from BIND 8.

(cherry picked from commit 105465d316)
2022-12-01 08:14:42 +01:00
Ondřej Surý
0d1c3ef7c2
Deprecate setting operating system limits from named.conf
It was possible to set operating system limits (RLIMIT_DATA,
RLIMIT_STACK, RLIMIT_CORE and RLIMIT_NOFILE) from named.conf.  It's
better to leave these untouched as setting these is responsibility of
the operating system and/or supervisor.

Deprecate the configuration options and remove them in future BIND 9
release.

(cherry picked from commit 379929e052)
2022-11-21 15:57:09 +01:00
Petr Špaček
fb6e5c2d28
Document that update-policy external is synchronous
(cherry picked from commit 7d352741a0)
2022-11-11 10:38:17 +01:00
Aram Sargsyan
6d64f9e4ec 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.

(cherry picked from commit ef344b1f52)
2022-10-21 10:22:44 +00:00
Petr Špaček
ce71fce811
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.

(cherry picked from commit 137e0f4e0e)

Adapted for v9_18 branch by doing cleanup also in
notes/notes-9.18.0.rst.
2022-10-05 11:55:03 +02:00
Tom Krizek
6cd00258fa
Remove trailing whitespaces
(cherry picked from commit ea2d213f34)
2022-10-05 11:44:33 +02:00
Petr Špaček
bba3440638
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.

(cherry picked from commit 9a7c2b370e)
2022-10-05 11:44:33 +02:00
Matthijs Mekking
d1a01d88f9 Update inline-signing requirement to ARM
This change was made in !6403, but the appropriate documentation
changes were not applied to the ARM.

(cherry picked from commit 5d454a7158)
2022-09-28 10:37:41 +02:00
Petr Menšík
dfc7b630db
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.

(cherry picked from commit bc6c6b1184)
2022-09-26 17:16:38 +02:00
Aram Sargsyan
e20cda5928 Document dynamic update forwarding limitation when XoT is enabled
BIND 9.18 does not support sending forwarded DDNS update requests
through DoT.
2022-09-22 10:54:56 +00:00
Ondřej Surý
474676a38c
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.

(cherry picked from commit 6869c98d36)
2022-09-15 10:58:09 +02:00
Evan Hunt
17da7dee5c flag "random-device" as obsolete
the "random-device" option was made non-functional in 9.13, but was
not marked as obsolete at that time. this is now fixed; configuring
"random-device" will trigger a warning.
2022-09-14 09:37:25 -07:00
Aram Sargsyan
f2982a5d3f Document RRL processing for wildcard names
All valid wildcard domain names are interpreted as the zone's origin
name concatenated to the "*" name.

(cherry picked from commit 89c2032421)
2022-09-08 09:36:50 +02:00
Suzanne Goldlust
cb6bf93298
Edit tag/statement for glue-cache and reserved-sockets 2022-08-15 09:17:36 +02:00
Petr Špaček
a2c59b949f
Add tags and short description to statements not documented in v9_19 2022-08-01 10:53:25 +02:00
Petr Špaček
67e8e8ff20
Add last missing tags, finishing touches
(cherry picked from commit 43c6a6a48b25930da217a888749780557c629252)
2022-08-01 10:12:13 +02:00
Suzanne Goldlust
c0177bfe4a
Add descriptions of each tag
(cherry picked from commit 8d765840901a79a1786abbcabe02e888eb0d3820)
2022-08-01 10:12:13 +02:00
Suzanne Goldlust
b2159d42b2
Text edits to Statements and Statements by Tag sections
(cherry picked from commit d4b93c4bd6eebaaafe3c40f43671113c5543f645)
2022-08-01 10:12:13 +02:00
Suzanne Goldlust
17d5e43e71
Reorder Statements and Statements by Tag sections
(cherry picked from commit 2cd32eb06df70b1959d3d41e519de44a9f3172bc)
2022-08-01 10:12:13 +02:00
Suzanne Goldlust
ac7d65557b
Rephrase parental-agents description
(cherry picked from commit 21c9166abb53a9f47017a43c380bc59320b6f0e4)
2022-08-01 10:12:12 +02:00
Suzanne Goldlust
3c45f366a6
Add short descriptions and some tags to statements through line 1766
(cherry picked from commit 21b8988f803e60ad39f7bb7770d7761a37e1d372)
2022-08-01 10:12:07 +02:00
Evan Hunt
a8e596e32c clarify "max-zone-ttl" documentation
The "max-zone-ttl" option should now be configured as part of
dnssec-policy. Use of this option in zone/view/options will be ignored
in any zone that also has dnssec-policy configured.
2022-07-22 13:13:24 -07:00
Petr Špaček
8db3a6789b
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.

(cherry picked from commit c3fed5ce40)
2022-07-04 16:09:25 +02:00
Suzanne Goldlust
e78ef65ef7
Grammar fixes and assorted text edits in the ARM
(cherry picked from commit 6db988e7e3)
2022-07-04 16:09:25 +02:00
Petr Špaček
9ee192d412
Add tables with statements by tag
(cherry picked from commit dd4dc78899)
2022-07-04 16:09:24 +02:00
Petr Špaček
6ef0b58026
Define topmost configuration blocks
(cherry picked from commit f91cbcf996)
2022-07-04 16:09:24 +02:00
Petr Špaček
6e8ee641a0
Alphabetize grammar glossary
(cherry picked from commit 8aea6694bf)
2022-07-04 16:09:24 +02:00
Petr Špaček
53993da1d9
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.

(cherry picked from commit 0138e5c1d5)
2022-07-04 16:09:24 +02:00
Petr Špaček
40a060e22e
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.

(cherry picked from commit decb4643d1)
2022-07-04 16:09:24 +02:00
Petr Špaček
845a2870df
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.

(cherry picked from commit 4915b1f3a1)
2022-07-04 16:09:24 +02:00
Petr Špaček
0edd5bf77b
Remove incorrect hyperlinks to file and unix definitions
Terms file and unix have overloaded meaning and were incorrectly linked
during the mass-linking campain.

(cherry picked from commit 1233c86ff7)
2022-07-04 16:09:24 +02:00
Petr Špaček
eeb05d5665
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.

(cherry picked from commit 8d9c2368a9)
2022-07-04 16:09:24 +02:00
Petr Špaček
2f0c9d4570
Remove path_name grammar definition
It was literally not used anywhere.

(cherry picked from commit 443fb5f34b)
2022-07-04 16:09:24 +02:00
Petr Špaček
4d62710be5
Hyperlink integer to its definition
(cherry picked from commit 55bc6d02a0)
2022-07-04 16:09:24 +02:00
Petr Špaček
69cda54461
Rename number to integer
The term number was used only in other definitions, and at the same time
doc/misc grammar uses term integer.

(cherry picked from commit 9885bf658d)
2022-07-04 16:09:24 +02:00
Petr Špaček
051d72a7ee
Clarify and hyperlink tls_id definition
(cherry picked from commit 6f754dae20)
2022-07-04 16:09:24 +02:00
Petr Špaček
2fd8ce0c46
Hyperlink server_id to its definition
(cherry picked from commit 116573a4a7)
2022-07-04 16:09:24 +02:00
Petr Špaček
830e118d6b
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.

(cherry picked from commit c972fad7b0)
2022-07-04 16:09:23 +02:00
Petr Špaček
3f93e5d9f9
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.

(cherry picked from commit 818219b36a)
2022-07-04 16:09:23 +02:00
Petr Špaček
38436b58d3
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.

(cherry picked from commit 686a15d30f)
2022-07-04 16:09:23 +02:00
Petr Špaček
388e36a4c4
Rename ip_port to port
The old name was used only in couple places, and was inconsistent with
doc/misc grammar.

(cherry picked from commit 7b51a027e7)
2022-07-04 16:09:23 +02:00
Petr Špaček
441e94fe48
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.

(cherry picked from commit d1644f420c)
2022-07-04 16:09:23 +02:00
Petr Špaček
aec7ae2d96
Hyperlink netprefix grammar references to the definition
(cherry picked from commit 5ce45d1c04)
2022-07-04 16:09:23 +02:00
Petr Špaček
f005a870d9
Hyperlink ip??_address grammar references to their definition
(cherry picked from commit a35c1ae0c2)
2022-07-04 16:09:23 +02:00