From cc2e144371499698f042cdab3bc02ee47e84a64e Mon Sep 17 00:00:00 2001 From: Suzanne Goldlust Date: Wed, 6 Jul 2022 16:57:05 +0000 Subject: [PATCH] Add tags/short descriptions for "zone" category --- doc/arm/reference.rst | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index 2489b32df8..9938c5b31d 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -1010,13 +1010,15 @@ change its delegation information (defined in :rfc:`7344`). :any:`primaries` Block Grammar ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. namedconf:statement:: primaries + :tags: zone + :short: Defines one or more primary servers for a zone. .. _primaries_statement: :any:`primaries` Block Definition and Usage ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:any:`primaries` lists allow for a common set of primary servers to be easily +:any:`primaries` lists allow for a common set of primary servers to be easily used by multiple stub and secondary zones in their :any:`primaries` or :any:`also-notify` lists. (Note: :any:`primaries` is a synonym for the original keyword ``masters``, which can still be used, but is no longer the @@ -6203,6 +6205,9 @@ Here is an example of a typical split DNS setup implemented using Zone Types ^^^^^^^^^^ .. namedconf:statement:: type + :tags: zone + :short: Specifies the kind of zone in a given configuration. + :suppress_grammar: The :any:`type` keyword is required for the :any:`zone` configuration unless @@ -6214,18 +6219,22 @@ Zone Types :any:`delegation-only `. .. namedconf:statement:: type primary + :tags: zone + :short: Contains the main copy of the data for a zone. A primary zone has a master copy of the data for the zone and is able to provide authoritative answers for it. Type ``master`` is a synonym for :any:`primary `. .. namedconf:statement:: type secondary + :tags: zone + :short: Contains a duplicate of the data for a zone that has been transferred from a primary server. A secondary zone is a replica of a primary zone. Type ``slave`` is a synonym for :any:`secondary `. The :any:`primaries` list specifies one or more IP addresses of primary servers that the secondary contacts to update - its copy of the zone. Primaries list elements can - also be names of other primaries lists. By default, + its copy of the zone. Primaries list elements can + also be names of other primaries lists. By default, transfers are made from port 53 on the servers; this can be changed for all servers by specifying a port number before the list of IP addresses, @@ -6247,9 +6256,11 @@ Zone Types ``ex/example.com``, where ``ex/`` is just the first two letters of the zone name. (Most operating systems - behave very slowly if there are 100000 files in a single directory.) + behave very slowly if there are 100,000 files in a single directory.) .. namedconf:statement:: type mirror + :tags: zone + :short: Contains a DNSSEC-validated duplicate of the main data for a zone. A mirror zone is similar to a zone of :any:`type secondary`, except its data is subject to DNSSEC validation before being used in answers. @@ -6317,6 +6328,8 @@ Zone Types especially for zones that are large and/or frequently updated. .. namedconf:statement:: type hint + :tags: zone + :short: Contains the initial set of root name servers to be used at BIND 9 startup. The initial set of root name servers is specified using a hint zone. When the server starts, it uses the root hints to find a root name @@ -6325,6 +6338,8 @@ Zone Types root servers hints. Classes other than IN have no built-in default hints. .. namedconf:statement:: type stub + :tags: zone + :short: Contains a duplicate of the NS records of a primary zone. A stub zone is similar to a secondary zone, except that it replicates only the NS records of a primary zone instead of the entire zone. Stub zones @@ -6346,6 +6361,8 @@ Zone Types internal name servers as the authoritative servers for that domain. .. namedconf:statement:: type static-stub + :tags: zone + :short: Contains a duplicate of the NS records of a primary zone, but statically configured rather than transferred from a primary server. A static-stub zone is similar to a stub zone, with the following exceptions: the zone data is statically configured, rather than @@ -6373,6 +6390,8 @@ Zone Types necessary) glue A or AAAA RRs. .. namedconf:statement:: type forward + :tags: zone + :short: Contains forwarding statements that apply to queries within a given domain. A forward zone is a way to configure forwarding on a per-domain basis. A :any:`zone` statement of type :any:`forward` can contain a :any:`forward` and/or @@ -6386,6 +6405,8 @@ Zone Types globally, re-specify the global forwarders. .. namedconf:statement:: type redirect + :tags: zone + :short: Contains information to answer queries when normal resolution would return NXDOMAIN. Redirect zones are used to provide answers to queries when normal resolution would result in NXDOMAIN being returned. Only one redirect zone @@ -6572,6 +6593,8 @@ Zone Options .. _file: .. namedconf:statement:: file + :tags: zone + :short: Specifies the zone's filename. This sets the zone's filename. In :any:`primary `, :any:`hint `, and :any:`redirect ` zones which do not have :any:`primaries` defined, zone data is loaded from