coredns/plugin/file
Miek Gieben 1d5095cf67
plugin/file: Rename do to walk and cleanup and document (#2987)
* plugin/file: Rename do to walk, cleanup and document

* This renames Do to Walk to be more inline with Go standards. Also make
  it return an error instead of a bool.
  Also give give walk access to rrs. Alternatively e.m could be
  exported, but just access the map of rrs should work as well. Another
  alternative would be adding a whole bunch of helper functions, but
  those need grab and return the data. Just having access to the rrs
  should be easiest for most Walks.
* It adds Type and TypeForWildcard to show the different functions
* *Removes* the identical RR check when inserting; this was only done
  for A, AAAA and MX and not finished; removed under the mantra garbage
  in garbage out.
* Reuses Types to return all the types in an *tree.Elem

Signed-off-by: Miek Gieben <miek@miek.nl>

* better comments

Signed-off-by: Miek Gieben <miek@miek.nl>
2019-07-18 17:44:47 +00:00
..
tree plugin/file: Rename do to walk and cleanup and document (#2987) 2019-07-18 17:44:47 +00:00
closest.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
closest_test.go presubmit: check for uppercase (#1774) 2018-05-07 23:47:25 +02:00
delegation_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
delete_test.go plugin/file: Rename do to walk and cleanup and document (#2987) 2019-07-18 17:44:47 +00:00
dname.go K8s remove string ops (#2119) 2018-09-22 15:12:02 +01:00
dname_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
dnssec_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
dnssex_test.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
ds_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
ent_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
example_org.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
file.go plugin/file: Rename do to walk and cleanup and document (#2987) 2019-07-18 17:44:47 +00:00
file_test.go presubmit: check for uppercase (#1774) 2018-05-07 23:47:25 +02:00
fuzz.go fuzz: put fuzzing stuff in own build tag (#1215) 2017-11-10 13:59:42 +00:00
glue_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
include_test.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
log_test.go Clean up tests logging (#1979) 2018-07-19 16:23:06 +01:00
lookup.go plugin/file: Rename do to walk and cleanup and document (#2987) 2019-07-18 17:44:47 +00:00
lookup_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
notify.go Use logging (#1718) 2018-04-22 21:40:33 +01:00
nsec3_test.go presubmit: check for uppercase (#1774) 2018-05-07 23:47:25 +02:00
OWNERS Add OWNERS file (#1486) 2018-02-08 10:55:51 +00:00
README.md plugin/file: make non-existent file non-fatal (#2955) 2019-07-04 13:56:37 +08:00
reload.go plugin/file: make non-existent file non-fatal (#2955) 2019-07-04 13:56:37 +08:00
reload_test.go plugin/file: make non-existent file non-fatal (#2955) 2019-07-04 13:56:37 +08:00
secondary.go plugin/file: load secondary zones lazily on startup (#2944) 2019-06-30 05:22:34 +08:00
secondary_test.go plugin/file: load secondary zones lazily on startup (#2944) 2019-06-30 05:22:34 +08:00
setup.go plugin/file: fix setting ReloadInterval (#3017) 2019-07-18 14:56:59 +00:00
setup_test.go plugin/file: fix setting ReloadInterval (#3017) 2019-07-18 14:56:59 +00:00
shutdown.go Configurable zone reload interval in file plugin (#2110) 2018-09-29 16:50:49 +01:00
wildcard.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
wildcard_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
xfr.go file: close correctlty after AXFR (#2943) 2019-07-03 07:01:57 +01:00
xfr_test.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
zone.go plugin/file: make non-existent file non-fatal (#2955) 2019-07-04 13:56:37 +08:00
zone_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00

file

Name

file - enables serving zone data from an RFC 1035-style master file.

Description

The file plugin is used for an "old-style" DNS server. It serves from a preloaded file that exists on disk. If the zone file contains signatures (i.e., is signed using DNSSEC), correct DNSSEC answers are returned. Only NSEC is supported! If you use this setup you are responsible for re-signing the zonefile.

Syntax

file DBFILE [ZONES...]
  • DBFILE the database file to read and parse. If the path is relative, the path from the root directive will be prepended to it.
  • ZONES zones it should be authoritative for. If empty, the zones from the configuration block are used.

If you want to round-robin A and AAAA responses look at the loadbalance plugin.

file DBFILE [ZONES... ] {
    transfer to ADDRESS...
    reload DURATION
}
  • transfer enables zone transfers. It may be specified multiples times. To or from signals the direction. ADDRESS must be denoted in CIDR notation (e.g., 127.0.0.1/32) or just as plain addresses. The special wildcard * means: the entire internet (only valid for 'transfer to'). When an address is specified a notify message will be sent whenever the zone is reloaded.
  • reload interval to perform a reload of the zone if the SOA version changes. Default is one minute. Value of 0 means to not scan for changes and reload. For example, 30s checks the zonefile every 30 seconds and reloads the zone when serial changes.

Examples

Load the example.org zone from example.org.signed and allow transfers to the internet, but send notifies to 10.240.1.1

example.org {
    file example.org.signed {
        transfer to *
        transfer to 10.240.1.1
    }
}

Or use a single zone file for multiple zones:

. {
    file example.org.signed example.org example.net {
        transfer to *
        transfer to 10.240.1.1
    }
}

Note that if you have a configuration like the following you may run into a problem of the origin not being correctly recognized:

. {
    file db.example.org
}

We omit the origin for the file db.example.org, so this references the zone in the server block, which, in this case, is the root zone. Any contents of db.example.org will then read with that origin set; this may or may not do what you want. It's better to be explicit here and specify the correct origin. This can be done in two ways:

. {
    file db.example.org example.org
}

Or

example.org {
    file db.example.org
}

Also See

See the loadbalance plugin if you need simple record shuffling.