Skip to content

C
Coredns
Commit 51cf388d authored by Miek Gieben's avatar Miek Gieben Committed by Yong Tang
Browse files
Options

doc: make -f Makefile.doc (#2919) 

mechanical change: create the manual pages.
Signed-off-by: default avatarMiek Gieben <miek@miek.nl>
parent e54b784a
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 423 additions and 286 deletions
man/coredns-any.7 0 → 100644
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-ANY" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
\fIany\fP - give a minimal response to ANY queries.
.SH "DESCRIPTION"
.PP
\fIany\fP basically blocks ANY queries by responding to them with a short HINFO reply. See RFC
8482
\[la]https://tools.ietf.org/html/rfc8482\[ra] for details.
.SH "SYNTAX"
.PP
.RS
.nf
any
.fi
.RE
.SH "EXAMPLES"
.PP
.RS
.nf
example.org {
whoami
any
}
.fi
.RE
.PP
A \fB\fCdig +nocmd ANY example.org +noall +answer\fR now returns:
.PP
.RS
.nf
example.org. 8482 IN HINFO "ANY obsoleted" "See RFC 8482"
.fi
.RE
.SH "ALSO SEE"
.PP
RFC 8482
\[la]https://tools.ietf.org/html/rfc8482\[ra].
man/coredns-auto.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-AUTO" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-AUTO" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIauto\fP - enables serving zone data from an RFC 1035-style master file, which is automatically picked up from disk. \fIauto\fP - enables serving zone data from an RFC 1035-style master file, which is automatically picked up from disk.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fIauto\fP plugin is used for an "old-style" DNS server. It serves from a preloaded file that exists The \fIauto\fP 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, i.e. using DNSSEC) correct DNSSEC answers on disk. If the zone file contains signatures (i.e. is signed, i.e. using DNSSEC) correct DNSSEC answers
are returned. Only NSEC is supported! If you use this setup \fIyou\fP are responsible for re-signing the are returned. Only NSEC is supported! If you use this setup \fIyou\fP are responsible for re-signing the
zonefile. New or changed zones are automatically picked up from disk. zonefile. New or changed zones are automatically picked up from disk.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -72,7 +72,7 @@ even though the directive might only receive queries for a specific zone. I.e: ...@@ -72,7 +72,7 @@ even though the directive might only receive queries for a specific zone. I.e:
Will happily pick up a zone for \fB\fCexample.COM\fR, except it will never be queried, because the \fIauto\fP Will happily pick up a zone for \fB\fCexample.COM\fR, except it will never be queried, because the \fIauto\fP
directive only is authoritative for \fB\fCexample.ORG\fR. directive only is authoritative for \fB\fCexample.ORG\fR.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Load \fB\fCorg\fR domains from \fB\fC/etc/coredns/zones/org\fR and allow transfers to the internet, but send Load \fB\fCorg\fR domains from \fB\fC/etc/coredns/zones/org\fR and allow transfers to the internet, but send
notifies to 10.240.1.1 notifies to 10.240.1.1
......
man/coredns-autopath.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-AUTOPATH" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-AUTOPATH" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIautopath\fP - allows for server-side search path completion. \fIautopath\fP - allows for server-side search path completion.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
If it sees a query that matches the first element of the configured search path, \fIautopath\fP will If it sees a query that matches the first element of the configured search path, \fIautopath\fP will
follow the chain of search path elements and return the first reply that is not NXDOMAIN. On any follow the chain of search path elements and return the first reply that is not NXDOMAIN. On any
...@@ -13,7 +13,7 @@ failures, the original reply is returned. Because \fIautopath\fP returns a reply ...@@ -13,7 +13,7 @@ failures, the original reply is returned. Because \fIautopath\fP returns a reply
the original question it will add a CNAME that points from the original name (with the search path the original question it will add a CNAME that points from the original name (with the search path
element in it) to the name of this answer. element in it) to the name of this answer.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -34,7 +34,7 @@ query) to retrieve the search list it should use. ...@@ -34,7 +34,7 @@ query) to retrieve the search list it should use.
.PP .PP
If a plugin implements the \fB\fCAutoPather\fR interface then it can be used. If a plugin implements the \fB\fCAutoPather\fR interface then it can be used.
.SH METRICS .SH "METRICS"
.PP .PP
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric is exported: If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric is exported:
...@@ -45,7 +45,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following ...@@ -45,7 +45,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following
.PP .PP
The \fB\fCserver\fR label is explained in the \fImetrics\fP plugin documentation. The \fB\fCserver\fR label is explained in the \fImetrics\fP plugin documentation.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
.RS .RS
...@@ -71,7 +71,7 @@ autopath @kubernetes ...@@ -71,7 +71,7 @@ autopath @kubernetes
.PP .PP
Use the search path dynamically retrieved from the \fIkubernetes\fP plugin. Use the search path dynamically retrieved from the \fIkubernetes\fP plugin.
.SH KNOWN ISSUES .SH "KNOWN ISSUES"
.PP .PP
In Kubernetes, \fIautopath\fP is not compatible with pods running from Windows nodes. In Kubernetes, \fIautopath\fP is not compatible with pods running from Windows nodes.
......
man/coredns-bind.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-BIND" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-BIND" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIbind\fP - overrides the host to which the server should bind. \fIbind\fP - overrides the host to which the server should bind.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
Normally, the listener binds to the wildcard host. However, you may want the listener to bind to Normally, the listener binds to the wildcard host. However, you may want the listener to bind to
another IP instead. another IP instead.
...@@ -16,7 +16,7 @@ If several addresses are provided, a listener will be open on each of the IP pro ...@@ -16,7 +16,7 @@ If several addresses are provided, a listener will be open on each of the IP pro
.PP .PP
Each address has to be an IP of one of the interfaces of the host. Each address has to be an IP of one of the interfaces of the host.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -30,7 +30,7 @@ bind ADDRESS ... ...@@ -30,7 +30,7 @@ bind ADDRESS ...
\fBADDRESS\fP is an IP address to bind to. \fBADDRESS\fP is an IP address to bind to.
When several addresses are provided a listener will be opened on each of the addresses. When several addresses are provided a listener will be opened on each of the addresses.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
To make your socket accessible only to that machine, bind to IP 127.0.0.1 (localhost): To make your socket accessible only to that machine, bind to IP 127.0.0.1 (localhost):
......
man/coredns-cache.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-CACHE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-CACHE" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIcache\fP - enables a frontend cache. \fIcache\fP - enables a frontend cache.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
With \fIcache\fP enabled, all records except zone transfers and metadata records will be cached for up to With \fIcache\fP enabled, all records except zone transfers and metadata records will be cached for up to
3600s. Caching is mostly useful in a scenario when fetching data from the backend (upstream, 3600s. Caching is mostly useful in a scenario when fetching data from the backend (upstream,
...@@ -14,7 +14,7 @@ database, etc.) is expensive. ...@@ -14,7 +14,7 @@ database, etc.) is expensive.
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -72,7 +72,7 @@ which defaults to \fB\fC10%\fR, or latest 1 second before TTL expiration. Values ...@@ -72,7 +72,7 @@ which defaults to \fB\fC10%\fR, or latest 1 second before TTL expiration. Values
Note the percent sign is mandatory. \fBPERCENTAGE\fP is treated as an \fB\fCint\fR. Note the percent sign is mandatory. \fBPERCENTAGE\fP is treated as an \fB\fCint\fR.
.SH CAPACITY AND EVICTION .SH "CAPACITY AND EVICTION"
.PP .PP
If \fBCAPACITY\fP \fIis not\fP specified, the default cache size is 9984 per cache. The minimum allowed cache size is 1024. If \fBCAPACITY\fP \fIis not\fP specified, the default cache size is 9984 per cache. The minimum allowed cache size is 1024.
If \fBCAPACITY\fP \fIis\fP specified, the actual cache size used will be rounded down to the nearest number divisible by 256 (so all shards are equal in size). If \fBCAPACITY\fP \fIis\fP specified, the actual cache size used will be rounded down to the nearest number divisible by 256 (so all shards are equal in size).
...@@ -83,7 +83,7 @@ Since shards don't fill up perfectly evenly, evictions will occur before the ent ...@@ -83,7 +83,7 @@ Since shards don't fill up perfectly evenly, evictions will occur before the ent
Each shard capacity is equal to the total cache size / number of shards (256). Eviction is random, not TTL based. Each shard capacity is equal to the total cache size / number of shards (256). Eviction is random, not TTL based.
Entries with 0 TTL will remain in the cache until randomly evicted when the shard reaches capacity. Entries with 0 TTL will remain in the cache until randomly evicted when the shard reaches capacity.
.SH METRICS .SH "METRICS"
.PP .PP
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported: If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported:
...@@ -101,7 +101,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following ...@@ -101,7 +101,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following
Cache types are either "denial" or "success". \fB\fCServer\fR is the server handling the request, see the Cache types are either "denial" or "success". \fB\fCServer\fR is the server handling the request, see the
metrics plugin for documentation. metrics plugin for documentation.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Enable caching for all zones, but cap everything to a TTL of 10 seconds: Enable caching for all zones, but cap everything to a TTL of 10 seconds:
......
man/coredns-cancel.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-CANCEL" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-CANCEL" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIcancel\fP - a plugin that cancels a request's context after 5001 milliseconds. \fIcancel\fP - a plugin that cancels a request's context after 5001 milliseconds.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fIcancel\fP plugin creates a canceling context for each request. It adds a timeout that gets The \fIcancel\fP plugin creates a canceling context for each request. It adds a timeout that gets
triggered after 5001 milliseconds. triggered after 5001 milliseconds.
...@@ -32,7 +32,7 @@ cancel [TIMEOUT] ...@@ -32,7 +32,7 @@ cancel [TIMEOUT]
\fBTIMEOUT\fP allows setting a custom timeout. The default timeout is 5001 milliseconds (\fB\fC5001 ms\fR) \fBTIMEOUT\fP allows setting a custom timeout. The default timeout is 5001 milliseconds (\fB\fC5001 ms\fR)
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
.RS .RS
...@@ -60,7 +60,7 @@ Or with a custom timeout: ...@@ -60,7 +60,7 @@ Or with a custom timeout:
.fi .fi
.RE .RE
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
The Go documentation for the context package. The Go documentation for the context package.
man/coredns-chaos.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-CHAOS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-CHAOS" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIchaos\fP - allows for responding to TXT queries in the CH class. \fIchaos\fP - allows for responding to TXT queries in the CH class.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
This is useful for retrieving version or author information from the server by querying a TXT record This is useful for retrieving version or author information from the server by querying a TXT record
for a special domainname in the CH class. for a special domainname in the CH class.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -31,7 +31,7 @@ Note that you have to make sure that this plugin will get actual queries for the ...@@ -31,7 +31,7 @@ Note that you have to make sure that this plugin will get actual queries for the
following zones: \fB\fCversion.bind\fR, \fB\fCversion.server\fR, \fB\fCauthors.bind\fR, \fB\fChostname.bind\fR and following zones: \fB\fCversion.bind\fR, \fB\fCversion.server\fR, \fB\fCauthors.bind\fR, \fB\fChostname.bind\fR and
\fB\fCid.server\fR. \fB\fCid.server\fR.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Specify all the zones in full. Specify all the zones in full.
......
man/coredns-debug.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-DEBUG" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-DEBUG" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIdebug\fP - disables the automatic recovery upon a crash so that you'll get a nice stack trace. \fIdebug\fP - disables the automatic recovery upon a crash so that you'll get a nice stack trace.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
Normally CoreDNS will recover from panics, using \fIdebug\fP inhibits this. The main use of \fIdebug\fP is Normally CoreDNS will recover from panics; using \fIdebug\fP inhibits this. The main use of \fIdebug\fP is
to help testing. A side effect of using \fIdebug\fP is that \fB\fClog.Debug\fR and \fB\fClog.Debugf\fR will be printed to help in testing. A side effect of using \fIdebug\fP is that \fB\fClog.Debug\fR and \fB\fClog.Debugf\fR messages
to standard output. will be printed to standard output.
.PP .PP
Note that the \fIerrors\fP plugin (if loaded) will also set a \fB\fCrecover\fR negating this setting. Note that the \fIerrors\fP plugin (if loaded) will also set a \fB\fCrecover\fR, negating this setting.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -25,7 +25,7 @@ debug ...@@ -25,7 +25,7 @@ debug
.RE .RE
.PP .PP
Some plugin will debug log DNS messages. This is done in the following format: Some plugins will send debug log DNS messages. This is done in the following format:
.PP .PP
.RS .RS
...@@ -40,14 +40,14 @@ debug: 00002a ...@@ -40,14 +40,14 @@ debug: 00002a
.RE .RE
.PP .PP
Using \fB\fCtext2pcap\fR (part of Wireshark) this can be converted back to binary, with the following Using \fB\fCtext2pcap\fR (part of Wireshark), this can be converted back to binary, with the following
command line: \fB\fCtext2pcap -i 17 -u 53,53\fR. Where 17 is the protocol (UDP) and 53 are the ports. These command line: \fB\fCtext2pcap -i 17 -u 53,53\fR, where 17 is the protocol (UDP) and 53 are the ports. These
ports allow wireshark to detect these packets as DNS messages. ports allow Wireshark to detect these packets as DNS messages.
.PP .PP
Each plugin can decide to dump messages to aid in debugging. Each plugin can decide whether to dump messages to aid in debugging.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Disable the ability to recover from crashes and show debug logging: Disable the ability to recover from crashes and show debug logging:
...@@ -62,7 +62,7 @@ Disable the ability to recover from crashes and show debug logging: ...@@ -62,7 +62,7 @@ Disable the ability to recover from crashes and show debug logging:
.fi .fi
.RE .RE
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
https://www.wireshark.org/docs/man-pages/text2pcap.html https://www.wireshark.org/docs/man-pages/text2pcap.html
\[la]https://www.wireshark.org/docs/man-pages/text2pcap.html\[ra]. \[la]https://www.wireshark.org/docs/man-pages/text2pcap.html\[ra].
......
man/coredns-dnssec.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-DNSSEC" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-DNSSEC" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIdnssec\fP - enable on-the-fly DNSSEC signing of served data. \fIdnssec\fP - enable on-the-fly DNSSEC signing of served data.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
With \fIdnssec\fP any reply that doesn't (or can't) do DNSSEC will get signed on the fly. Authenticated With \fIdnssec\fP any reply that doesn't (or can't) do DNSSEC will get signed on the fly. Authenticated
denial of existence is implemented with NSEC black lies. Using ECDSA as an algorithm is preferred as denial of existence is implemented with NSEC black lies. Using ECDSA as an algorithm is preferred as
...@@ -14,7 +14,7 @@ this leads to smaller signatures (compared to RSA). NSEC3 is \fInot\fP supported ...@@ -14,7 +14,7 @@ this leads to smaller signatures (compared to RSA). NSEC3 is \fInot\fP supported
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -67,7 +67,7 @@ generated private key \fB\fCKexample.org+013+45330.private\fR ...@@ -67,7 +67,7 @@ generated private key \fB\fCKexample.org+013+45330.private\fR
RRSIGs. The default for \fBCAPACITY\fP is 10000. RRSIGs. The default for \fBCAPACITY\fP is 10000.
.SH METRICS .SH "METRICS"
.PP .PP
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported: If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported:
...@@ -82,7 +82,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following ...@@ -82,7 +82,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following
.PP .PP
The label \fB\fCserver\fR indicated the server handling the request, see the \fImetrics\fP plugin for details. The label \fB\fCserver\fR indicated the server handling the request, see the \fImetrics\fP plugin for details.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Sign responses for \fB\fCexample.org\fR with the key "Kexample.org.+013+45330.key". Sign responses for \fB\fCexample.org\fR with the key "Kexample.org.+013+45330.key".
......
man/coredns-dnstap.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-DNSTAP" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-DNSTAP" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIdnstap\fP - enable logging to dnstap. \fIdnstap\fP - enable logging to dnstap.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
dnstap is a flexible, structured binary log format for DNS software: http://dnstap.info dnstap is a flexible, structured binary log format for DNS software: http://dnstap.info
\[la]http://dnstap.info\[ra]. With this \[la]http://dnstap.info\[ra]. With this
...@@ -15,7 +15,7 @@ plugin you make CoreDNS output dnstap logging. ...@@ -15,7 +15,7 @@ plugin you make CoreDNS output dnstap logging.
Note that there is an internal buffer, so expect at least 13 requests before the server sends its Note that there is an internal buffer, so expect at least 13 requests before the server sends its
dnstap messages to the socket. dnstap messages to the socket.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -31,7 +31,7 @@ dnstap SOCKET [full] ...@@ -31,7 +31,7 @@ dnstap SOCKET [full]
\fB\fCfull\fR to include the wire-format DNS message. \fB\fCfull\fR to include the wire-format DNS message.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Log information about client requests and responses to \fI/tmp/dnstap.sock\fP. Log information about client requests and responses to \fI/tmp/dnstap.sock\fP.
...@@ -68,7 +68,7 @@ dnstap tcp://127.0.0.1:6000 full ...@@ -68,7 +68,7 @@ dnstap tcp://127.0.0.1:6000 full
.fi .fi
.RE .RE
.SH COMMAND LINE TOOL .SH "COMMAND LINE TOOL"
.PP .PP
Dnstap has a command line tool that can be used to inspect the logging. The tool can be found Dnstap has a command line tool that can be used to inspect the logging. The tool can be found
at Github: https://github.com/dnstap/golang-dnstap at Github: https://github.com/dnstap/golang-dnstap
...@@ -110,7 +110,7 @@ $ dnstap \-l 127.0.0.1:6000 ...@@ -110,7 +110,7 @@ $ dnstap \-l 127.0.0.1:6000
.fi .fi
.RE .RE
.SH USING DNSTAP IN YOUR PLUGIN .SH "USING DNSTAP IN YOUR PLUGIN"
.PP .PP
.RS .RS
...@@ -138,7 +138,7 @@ func (h Dnstap) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) ...@@ -138,7 +138,7 @@ func (h Dnstap) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg)
.fi .fi
.RE .RE
.SH SEE ALSO .SH "SEE ALSO"
.PP .PP
dnstap.info dnstap.info
\[la]http://dnstap.info\[ra]. \[la]http://dnstap.info\[ra].
......
man/coredns-erratic.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-ERRATIC" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-ERRATIC" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIerratic\fP - a plugin useful for testing client behavior. \fIerratic\fP - a plugin useful for testing client behavior.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
\fIerratic\fP returns a static response to all queries, but the responses can be delayed, dropped or truncated. \fIerratic\fP returns a static response to all queries, but the responses can be delayed, dropped or truncated.
The \fIerratic\fP plugin will respond to every A or AAAA query. For any other type it will return The \fIerratic\fP plugin will respond to every A or AAAA query. For any other type it will return
...@@ -20,7 +20,7 @@ AXFR request it will respond with a small zone transfer. ...@@ -20,7 +20,7 @@ AXFR request it will respond with a small zone transfer.
\fIerratic\fP can also be used in conjunction with the \fIautopath\fP plugin. This is mostly to aid in \fIerratic\fP can also be used in conjunction with the \fIautopath\fP plugin. This is mostly to aid in
testing. testing.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -46,11 +46,11 @@ the default for \fBDURATION\fP is 100ms. ...@@ -46,11 +46,11 @@ the default for \fBDURATION\fP is 100ms.
.PP .PP
In case of a zone transfer and truncate the final SOA record \fIisn't\fP added to the response. In case of a zone transfer and truncate the final SOA record \fIisn't\fP added to the response.
.SH READY .SH "READY"
.PP .PP
This plugin reports readiness to the ready plugin. This plugin reports readiness to the ready plugin.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
.RS .RS
...@@ -128,7 +128,7 @@ Drop every second query. ...@@ -128,7 +128,7 @@ Drop every second query.
.fi .fi
.RE .RE
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
RFC 3849 RFC 3849
\[la]https://tools.ietf.org/html/rfc3849\[ra] and \[la]https://tools.ietf.org/html/rfc3849\[ra] and
......
man/coredns-errors.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-ERRORS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-ERRORS" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIerrors\fP - enable error logging. \fIerrors\fP - enable error logging.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
Any errors encountered during the query processing will be printed to standard output. The errors of particular type can be consolidated and printed once per some period of time. Any errors encountered during the query processing will be printed to standard output. The errors of particular type can be consolidated and printed once per some period of time.
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
The basic syntax is: The basic syntax is:
...@@ -57,7 +57,7 @@ Multiple \fB\fCconsolidate\fR options with different \fBDURATION\fP and \fBREGEX ...@@ -57,7 +57,7 @@ Multiple \fB\fCconsolidate\fR options with different \fBDURATION\fP and \fBREGEX
.PP .PP
For better performance, it's recommended to use the \fB\fC^\fR or \fB\fC$\fR metacharacters in regular expression when filtering error messages by prefix or suffix, e.g. \fB\fC^failed to .*\fR, or \fB\fC.* timeout$\fR. For better performance, it's recommended to use the \fB\fC^\fR or \fB\fC$\fR metacharacters in regular expression when filtering error messages by prefix or suffix, e.g. \fB\fC^failed to .*\fR, or \fB\fC.* timeout$\fR.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Use the \fIwhoami\fP to respond to queries and Log errors to standard output. Use the \fIwhoami\fP to respond to queries and Log errors to standard output.
......
man/coredns-file.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-FILE" 7 "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-FILE" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
...@@ -50,7 +50,7 @@ file DBFILE [ZONES... ] { ...@@ -50,7 +50,7 @@ file DBFILE [ZONES... ] {
\fB\fCtransfer\fR enables zone transfers. It may be specified multiples times. \fB\fCTo\fR or \fB\fCfrom\fR signals \fB\fCtransfer\fR enables zone transfers. It may be specified multiples times. \fB\fCTo\fR or \fB\fCfrom\fR signals
the direction. \fBADDRESS\fP must be denoted in CIDR notation (e.g., 127.0.0.1/32) or just as plain the direction. \fBADDRESS\fP must be denoted in CIDR notation (e.g., 127.0.0.1/32) or just as plain
addresses. The special wildcard \fB\fC*\fR means: the entire internet (only valid for 'transfer to'). addresses. The special wildcard \fB\fC*\fR means: the entire internet (only valid for 'transfer to').
When an address is specified a notify message will be send whenever the zone is reloaded. When an address is specified a notify message will be sent whenever the zone is reloaded.
.IP \(bu 4 .IP \(bu 4
\fB\fCreload\fR interval to perform a reload of the zone if the SOA version changes. Default is one minute. \fB\fCreload\fR interval to perform a reload of the zone if the SOA version changes. Default is one minute.
Value of \fB\fC0\fR means to not scan for changes and reload. For example, \fB\fC30s\fR checks the zonefile every 30 seconds Value of \fB\fC0\fR means to not scan for changes and reload. For example, \fB\fC30s\fR checks the zonefile every 30 seconds
...@@ -97,3 +97,49 @@ Or use a single zone file for multiple zones: ...@@ -97,3 +97,49 @@ Or use a single zone file for multiple zones:
.fi .fi
.RE .RE
.PP
Note that if you have a configuration like the following you may run into a problem of the origin
not being correctly recognized:
.PP
.RS
.nf
\&. {
file db.example.org
}
.fi
.RE
.PP
We omit the origin for the file \fB\fCdb.example.org\fR, so this references the zone in the server block,
which, in this case, is the root zone. Any contents of \fB\fCdb.example.org\fR 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:
.PP
.RS
.nf
\&. {
file db.example.org example.org
}
.fi
.RE
.PP
Or
.PP
.RS
.nf
example.org {
file db.example.org
}
.fi
.RE
man/coredns-forward.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-FORWARD" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-FORWARD" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIforward\fP - facilitates proxying DNS messages to upstream resolvers. \fIforward\fP - facilitates proxying DNS messages to upstream resolvers.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fIforward\fP plugin re-uses already opened sockets to the upstreams. It supports UDP, TCP and The \fIforward\fP plugin re-uses already opened sockets to the upstreams. It supports UDP, TCP and
DNS-over-TLS and uses in band health checking. DNS-over-TLS and uses in band health checking.
...@@ -25,7 +25,7 @@ connect to a random upstream (which may or may not work). ...@@ -25,7 +25,7 @@ connect to a random upstream (which may or may not work).
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
In its most basic form, a simple forwarder uses this syntax: In its most basic form, a simple forwarder uses this syntax:
...@@ -140,7 +140,7 @@ dialTimeout by default is 30 sec, and can decrease automatically down to 100ms ...@@ -140,7 +140,7 @@ dialTimeout by default is 30 sec, and can decrease automatically down to 100ms
readTimeout by default is 2 sec, and can decrease automatically down to 200ms readTimeout by default is 2 sec, and can decrease automatically down to 200ms
.SH METRICS .SH "METRICS"
.PP .PP
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric are exported: If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric are exported:
...@@ -164,7 +164,7 @@ Where \fB\fCto\fR is one of the upstream servers (\fBTO\fP from the config), \fB ...@@ -164,7 +164,7 @@ Where \fB\fCto\fR is one of the upstream servers (\fBTO\fP from the config), \fB
the incoming query ("tcp" or "udp"), and family the transport family ("1" for IPv4, and "2" for the incoming query ("tcp" or "udp"), and family the transport family ("1" for IPv4, and "2" for
IPv6). IPv6).
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Proxy all requests within \fB\fCexample.org.\fR to a nameserver running on a different port: Proxy all requests within \fB\fCexample.org.\fR to a nameserver running on a different port:
...@@ -264,12 +264,12 @@ Or with multiple upstreams from the same provider ...@@ -264,12 +264,12 @@ Or with multiple upstreams from the same provider
.fi .fi
.RE .RE
.SH BUGS .SH "BUGS"
.PP .PP
The TLS config is global for the whole forwarding proxy if you need a different \fB\fCtls_servername\fR for The TLS config is global for the whole forwarding proxy if you need a different \fB\fCtls_servername\fR for
different upstreams you're out of luck. different upstreams you're out of luck.
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
RFC 7858 RFC 7858
\[la]https://tools.ietf.org/html/rfc7858\[ra] for DNS over TLS. \[la]https://tools.ietf.org/html/rfc7858\[ra] for DNS over TLS.
......
man/coredns-grpc.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-GRPC" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-GRPC" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIgrpc\fP - facilitates proxying DNS messages to upstream resolvers via gRPC protocol. \fIgrpc\fP - facilitates proxying DNS messages to upstream resolvers via gRPC protocol.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fIgrpc\fP plugin supports gRPC and TLS. The \fIgrpc\fP plugin supports gRPC and TLS.
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
In its most basic form: In its most basic form:
...@@ -88,7 +88,7 @@ but they have to use the same \fB\fCtls_servername\fR. E.g. mixing 9.9.9.9 (Quad ...@@ -88,7 +88,7 @@ but they have to use the same \fB\fCtls_servername\fR. E.g. mixing 9.9.9.9 (Quad
Also note the TLS config is "global" for the whole grpc proxy if you need a different Also note the TLS config is "global" for the whole grpc proxy if you need a different
\fB\fCtls-name\fR for different upstreams you're out of luck. \fB\fCtls-name\fR for different upstreams you're out of luck.
.SH METRICS .SH "METRICS"
.PP .PP
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric are exported: If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric are exported:
...@@ -101,7 +101,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following ...@@ -101,7 +101,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following
and we are randomly (this always uses the \fB\fCrandom\fR policy) spraying to an upstream. and we are randomly (this always uses the \fB\fCrandom\fR policy) spraying to an upstream.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Proxy all requests within \fB\fCexample.org.\fR to a nameserver running on a different port: Proxy all requests within \fB\fCexample.org.\fR to a nameserver running on a different port:
...@@ -198,7 +198,7 @@ Or with multiple upstreams from the same provider ...@@ -198,7 +198,7 @@ Or with multiple upstreams from the same provider
.fi .fi
.RE .RE
.SH BUGS .SH "BUGS"
.PP .PP
The TLS config is global for the whole grpc proxy if you need a different \fB\fCtls_servername\fR for The TLS config is global for the whole grpc proxy if you need a different \fB\fCtls_servername\fR for
different upstreams you're out of luck. different upstreams you're out of luck.
......
man/coredns-health.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-HEALTH" 7 "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-HEALTH" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
Enabled process wide health endpoint. When CoreDNS is up and running this returns a 200 OK http Enabled process wide health endpoint. When CoreDNS is up and running this returns a 200 OK HTTP
status code. The health is exported, by default, on port 8080/health . status code. The health is exported, by default, on port 8080/health .
.SH "SYNTAX" .SH "SYNTAX"
...@@ -113,10 +113,3 @@ Set a lameduck duration of 1 second: ...@@ -113,10 +113,3 @@ Set a lameduck duration of 1 second:
.fi .fi
.RE .RE
.SH "BUGS"
.PP
When reloading, the health handler is stopped before the new server instance is started. If that
new server fails to start, then the initial server instance is still available and DNS queries still
served, but health handler stays down. Health will not reply HTTP request until a successful reload
or a complete restart of CoreDNS.
man/coredns-hosts.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-HOSTS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-HOSTS" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIhosts\fP - enables serving zone data from a \fB\fC/etc/hosts\fR style file. \fIhosts\fP - enables serving zone data from a \fB\fC/etc/hosts\fR style file.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The hosts plugin is useful for serving zones from a \fB\fC/etc/hosts\fR file. It serves from a preloaded The hosts plugin is useful for serving zones from a \fB\fC/etc/hosts\fR file. It serves from a preloaded
file that exists on disk. It checks the file for changes and updates the zones accordingly. This file that exists on disk. It checks the file for changes and updates the zones accordingly. This
...@@ -19,9 +19,9 @@ Should the file be deleted, any inlined content will continue to be served. When ...@@ -19,9 +19,9 @@ Should the file be deleted, any inlined content will continue to be served. When
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH THE HOSTS FILE .SH "THE HOSTS FILE"
.PP .PP
Commonly the entries are of the from \fB\fCIP_address canonical_hostname [aliases...]\fR as explained by the hosts(5) man page. Commonly the entries are of the form \fB\fCIP_address canonical_hostname [aliases...]\fR as explained by the hosts(5) man page.
.PP .PP
Examples: Examples:
...@@ -39,11 +39,11 @@ fdfc:a744:27b5:3b0e::1 example.com example ...@@ -39,11 +39,11 @@ fdfc:a744:27b5:3b0e::1 example.com example
.fi .fi
.RE .RE
.SS PTR RECORDS .SS "PTR RECORDS"
.PP .PP
PTR records for reverse lookups are generated automatically by CoreDNS (based on the hosts file entries) and cannot be created manually. PTR records for reverse lookups are generated automatically by CoreDNS (based on the hosts file entries) and cannot be created manually.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -83,7 +83,7 @@ is authoritative. If specific zones are listed (for example \fB\fCin-addr.arpa\f ...@@ -83,7 +83,7 @@ is authoritative. If specific zones are listed (for example \fB\fCin-addr.arpa\f
queries for those zones will be subject to fallthrough. queries for those zones will be subject to fallthrough.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Load \fB\fC/etc/hosts\fR file. Load \fB\fC/etc/hosts\fR file.
...@@ -146,7 +146,7 @@ Load hosts file inlined in Corefile. ...@@ -146,7 +146,7 @@ Load hosts file inlined in Corefile.
.fi .fi
.RE .RE
.SH SEE ALSO .SH "SEE ALSO"
.PP .PP
The form of the entries in the \fB\fC/etc/hosts\fR file are based on IETF RFC 952 The form of the entries in the \fB\fC/etc/hosts\fR file are based on IETF RFC 952
\[la]https://tools.ietf.org/html/rfc952\[ra] which was updated by IETF RFC 1123 \[la]https://tools.ietf.org/html/rfc952\[ra] which was updated by IETF RFC 1123
......
man/coredns-import.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-IMPORT" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-IMPORT" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIimport\fP - include files or reference snippets from a Corefile. \fIimport\fP - include files or reference snippets from a Corefile.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fIimport\fP plugin can be used to include files into the main configuration. Another use it to The \fIimport\fP plugin can be used to include files into the main configuration. Another use it to
reference predefined snippets. Both can help to avoid some duplication. reference predefined snippets. Both can help to avoid some duplication.
...@@ -14,7 +14,7 @@ reference predefined snippets. Both can help to avoid some duplication. ...@@ -14,7 +14,7 @@ reference predefined snippets. Both can help to avoid some duplication.
This is a unique directive in that \fIimport\fP can appear outside of a server block. In other words, it This is a unique directive in that \fIimport\fP can appear outside of a server block. In other words, it
can appear at the top of a Corefile where an address would normally be. can appear at the top of a Corefile where an address would normally be.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -29,13 +29,13 @@ import PATTERN ...@@ -29,13 +29,13 @@ import PATTERN
this line, as if that file's contents appeared here to begin with. this line, as if that file's contents appeared here to begin with.
.SH FILES .SH "FILES"
.PP .PP
You can use \fIimport\fP to include a file or files. This file's location is relative to the You can use \fIimport\fP to include a file or files. This file's location is relative to the
Corefile's location. It is an error if a specific file cannot be found, but an empty glob pattern is Corefile's location. It is an error if a specific file cannot be found, but an empty glob pattern is
not an error. not an error.
.SH SNIPPETS .SH "SNIPPETS"
.PP .PP
You can define snippets to be reused later in your Corefile by defining a block with a single-token You can define snippets to be reused later in your Corefile by defining a block with a single-token
label surrounded by parentheses: label surrounded by parentheses:
...@@ -63,7 +63,7 @@ import mysnippet ...@@ -63,7 +63,7 @@ import mysnippet
.fi .fi
.RE .RE
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Import a shared configuration: Import a shared configuration:
...@@ -104,7 +104,7 @@ import ../zones/* ...@@ -104,7 +104,7 @@ import ../zones/*
.fi .fi
.RE .RE
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
See corefile(5). See corefile(5).
man/coredns-k8s_external.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-K8S_EXTERNAL" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-K8S_EXTERNAL" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIk8s_external\fP - resolve load balancer and external IPs from outside kubernetes clusters. \fIk8s_external\fP - resolve load balancer and external IPs from outside kubernetes clusters.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
This plugin allows an additional zone to resolve the external IP address(es) of a Kubernetes This plugin allows an additional zone to resolve the external IP address(es) of a Kubernetes
service. This plugin is only useful if the \fIkubernetes\fP plugin is also loaded. service. This plugin is only useful if the \fIkubernetes\fP plugin is also loaded.
...@@ -46,7 +46,7 @@ CoreDNS service. ...@@ -46,7 +46,7 @@ CoreDNS service.
The \fIk8s_external\fP plugin handles the subdomain \fB\fCdns\fR and the apex of the zone by itself, all other The \fIk8s_external\fP plugin handles the subdomain \fB\fCdns\fR and the apex of the zone by itself, all other
queries are resolved to addresses in the cluster. queries are resolved to addresses in the cluster.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
......
man/coredns-kubernetes.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-KUBERNETES" 7 "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-KUBERNETES" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
...@@ -324,3 +324,26 @@ For example, wildcards can be used to resolve all Endpoints for a Service as \fB ...@@ -324,3 +324,26 @@ For example, wildcards can be used to resolve all Endpoints for a Service as \fB
.PP .PP
This response can be randomized using the \fB\fCloadbalance\fR plugin This response can be randomized using the \fB\fCloadbalance\fR plugin
.SH "METADATA"
.PP
The kubernetes plugin will publish the following metadata, if the \fImetadata\fP
plugin is also enabled:
.IP \(bu 4
kubernetes/endpoint: the endpoint name in the query
.IP \(bu 4
kubernetes/kind: the resource kind (pod or svc) in the query
.IP \(bu 4
kubernetes/namespace: the namespace in the query
.IP \(bu 4
kubernetes/port-name: the port name in an SRV query
.IP \(bu 4
kubernetes/protocol: the protocol in an SRV query
.IP \(bu 4
kubernetes/service: the service name in the query
.IP \(bu 4
kubernetes/client-namespace: the client pod's namespace, if \fB\fCpods verified\fR mode is enabled
.IP \(bu 4
kubernetes/client-pod-name: the client pod's name, if \fB\fCpods verified\fR mode is enabled
man/coredns-loadbalance.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-LOADBALANCE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-LOADBALANCE" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIloadbalance\fP - randomize the order of A, AAAA and MX records. \fIloadbalance\fP - randomize the order of A, AAAA and MX records.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fIloadbalance\fP will act as a round-robin DNS loadbalancer by randomizing the order of A, AAAA, The \fIloadbalance\fP will act as a round-robin DNS loadbalancer by randomizing the order of A, AAAA,
and MX records in the answer. and MX records in the answer.
...@@ -16,7 +16,7 @@ See Wikipedia ...@@ -16,7 +16,7 @@ See Wikipedia
setup. It will take care to sort any CNAMEs before any address records, because some stub resolver setup. It will take care to sort any CNAMEs before any address records, because some stub resolver
implementations (like glibc) are particular about that. implementations (like glibc) are particular about that.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -30,7 +30,7 @@ loadbalance [POLICY] ...@@ -30,7 +30,7 @@ loadbalance [POLICY]
\fBPOLICY\fP is how to balance, the default, and only option, is "round_robin". \fBPOLICY\fP is how to balance, the default, and only option, is "round_robin".
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Load balance replies coming back from Google Public DNS: Load balance replies coming back from Google Public DNS:
......
man/coredns-log.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-LOG" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-LOG" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIlog\fP - enables query logging to standard output. \fIlog\fP - enables query logging to standard output.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
By just using \fIlog\fP you dump all queries (and parts for the reply) on standard output. Options exist By just using \fIlog\fP you dump all queries (and parts for the reply) on standard output. Options exist
to tweak the output a little. The date/time prefix on log lines is RFC3339 formatted with to tweak the output a little. The date/time prefix on log lines is RFC3339 formatted with
...@@ -14,7 +14,7 @@ milliseconds. ...@@ -14,7 +14,7 @@ milliseconds.
.PP .PP
Note that for busy servers logging will incur a performance hit. Note that for busy servers logging will incur a performance hit.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -85,7 +85,7 @@ logged whatever we mix together with "all". ...@@ -85,7 +85,7 @@ logged whatever we mix together with "all".
.PP .PP
If no class is specified, it defaults to \fIall\fP. If no class is specified, it defaults to \fIall\fP.
.SH LOG FORMAT .SH "LOG FORMAT"
.PP .PP
You can specify a custom log format with any placeholder values. Log supports both request and You can specify a custom log format with any placeholder values. Log supports both request and
response placeholders. response placeholders.
......
man/coredns-loop.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-LOOP" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-LOOP" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIloop\fP - detect simple forwarding loops and halt the server. \fIloop\fP - detect simple forwarding loops and halt the server.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fIloop\fP plugin will send a random probe query to ourselves and will then keep track of how many times The \fIloop\fP plugin will send a random probe query to ourselves and will then keep track of how many times
we see it. If we see it more than twice, we assume CoreDNS has seen a forwarding loop and we halt the process. we see it. If we see it more than twice, we assume CoreDNS has seen a forwarding loop and we halt the process.
...@@ -18,7 +18,7 @@ death. ...@@ -18,7 +18,7 @@ death.
.PP .PP
The query sent is \fB\fC<random number>.<random number>.zone\fR with type set to HINFO. The query sent is \fB\fC<random number>.<random number>.zone\fR with type set to HINFO.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -28,7 +28,7 @@ loop ...@@ -28,7 +28,7 @@ loop
.fi .fi
.RE .RE
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Start a server on the default port and load the \fIloop\fP and \fIforward\fP plugins. The \fIforward\fP plugin Start a server on the default port and load the \fIloop\fP and \fIforward\fP plugins. The \fIforward\fP plugin
forwards to it self. forwards to it self.
...@@ -57,7 +57,7 @@ plugin/loop: Loop (127.0.0.1:55953 \-> :1053) detected for zone ".", see https:/ ...@@ -57,7 +57,7 @@ plugin/loop: Loop (127.0.0.1:55953 \-> :1053) detected for zone ".", see https:/
.fi .fi
.RE .RE
.SH LIMITATIONS .SH "LIMITATIONS"
.PP .PP
This plugin only attempts to find simple static forwarding loops at start up time. To detect a loop, This plugin only attempts to find simple static forwarding loops at start up time. To detect a loop,
the following must be true: the following must be true:
...@@ -68,7 +68,7 @@ the loop must be present at start up time. ...@@ -68,7 +68,7 @@ the loop must be present at start up time.
the loop must occur for the \fB\fCHINFO\fR query type. the loop must occur for the \fB\fCHINFO\fR query type.
.SH TROUBLESHOOTING .SH "TROUBLESHOOTING"
.PP .PP
When CoreDNS logs contain the message \fB\fCLoop ... detected ...\fR, this means that the \fB\fCloop\fR detection When CoreDNS logs contain the message \fB\fCLoop ... detected ...\fR, this means that the \fB\fCloop\fR detection
plugin has detected an infinite forwarding loop in one of the upstream DNS servers. This is a fatal plugin has detected an infinite forwarding loop in one of the upstream DNS servers. This is a fatal
...@@ -90,7 +90,7 @@ in which the loop was detected. Make sure that they are not forwarding to a loc ...@@ -90,7 +90,7 @@ in which the loop was detected. Make sure that they are not forwarding to a loc
to another DNS server that is forwarding requests back to CoreDNS. If \fB\fCforward\fR is to another DNS server that is forwarding requests back to CoreDNS. If \fB\fCforward\fR is
using a file (e.g. \fB\fC/etc/resolv.conf\fR), make sure that file does not contain local addresses. using a file (e.g. \fB\fC/etc/resolv.conf\fR), make sure that file does not contain local addresses.
.SS TROUBLESHOOTING LOOPS IN KUBERNETES CLUSTERS .SS "TROUBLESHOOTING LOOPS IN KUBERNETES CLUSTERS"
.PP .PP
When a CoreDNS Pod deployed in Kubernetes detects a loop, the CoreDNS Pod will start to "CrashLoopBackOff". When a CoreDNS Pod deployed in Kubernetes detects a loop, the CoreDNS Pod will start to "CrashLoopBackOff".
This is because Kubernetes will try to restart the Pod every time CoreDNS detects the loop and exits. This is because Kubernetes will try to restart the Pod every time CoreDNS detects the loop and exits.
...@@ -108,7 +108,7 @@ requests to itself. ...@@ -108,7 +108,7 @@ requests to itself.
There are many ways to work around this issue, some are listed here: There are many ways to work around this issue, some are listed here:
.IP \(bu 4 .IP \(bu 4
Add the following to \fB\fCkubelet\fR: \fB\fC--resolv-conf <path-to-your-real-resolv-conf-file>\fR. Your "real" Add the following to your \fB\fCkubelet\fR config yaml: \fB\fCresolvConf: <path-to-your-real-resolv-conf-file>\fR (or via command line flag \fB\fC--resolv-conf\fR deprecated in 1.10). Your "real"
\fB\fCresolv.conf\fR is the one that contains the actual IPs of your upstream servers, and no local/loopback address. \fB\fCresolv.conf\fR is the one that contains the actual IPs of your upstream servers, and no local/loopback address.
This flag tells \fB\fCkubelet\fR to pass an alternate \fB\fCresolv.conf\fR to Pods. For systems using \fB\fCsystemd-resolved\fR, This flag tells \fB\fCkubelet\fR to pass an alternate \fB\fCresolv.conf\fR to Pods. For systems using \fB\fCsystemd-resolved\fR,
\fB\fC/run/systemd/resolve/resolv.conf\fR is typically the location of the "real" \fB\fCresolv.conf\fR, \fB\fC/run/systemd/resolve/resolv.conf\fR is typically the location of the "real" \fB\fCresolv.conf\fR,
......
man/coredns-metadata.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-METADATA" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-METADATA" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fImetadata\fP - enable a meta data collector. \fImetadata\fP - enable a meta data collector.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
By enabling \fImetadata\fP any plugin that implements metadata.Provider By enabling \fImetadata\fP any plugin that implements metadata.Provider
interface interface
...@@ -28,7 +28,7 @@ plugin enforces is that the labels contains a slash. See the documentation for ...@@ -28,7 +28,7 @@ plugin enforces is that the labels contains a slash. See the documentation for
The value stored is a string. The empty string signals "no meta data". See the documentation for The value stored is a string. The empty string signals "no meta data". See the documentation for
\fB\fCmetadata.ValueFunc\fR on how to retrieve this. \fB\fCmetadata.ValueFunc\fR on how to retrieve this.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -42,7 +42,7 @@ metadata [ZONES... ] ...@@ -42,7 +42,7 @@ metadata [ZONES... ]
\fBZONES\fP zones metadata should be invoked for. \fBZONES\fP zones metadata should be invoked for.
.SH PLUGINS .SH "PLUGINS"
.PP .PP
\fB\fCmetadata.Provider\fR interface needs to be implemented by each plugin willing to provide metadata \fB\fCmetadata.Provider\fR interface needs to be implemented by each plugin willing to provide metadata
information for other plugins. It will be called by metadata and gather the information from all information for other plugins. It will be called by metadata and gather the information from all
...@@ -51,11 +51,11 @@ plugins in context. ...@@ -51,11 +51,11 @@ plugins in context.
.PP .PP
Note: this method should work quickly, because it is called for every request. Note: this method should work quickly, because it is called for every request.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
The \fIrewrite\fP plugin uses meta data to rewrite requests. The \fIrewrite\fP plugin uses meta data to rewrite requests.
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
The Provider interface The Provider interface
\[la]https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider\[ra] and \[la]https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider\[ra] and
......
man/coredns-metrics.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-METRICS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-METRICS" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIprometheus\fP - enables Prometheus \fIprometheus\fP - enables Prometheus
\[la]https://prometheus.io/\[ra] metrics. \[la]https://prometheus.io/\[ra] metrics.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
With \fIprometheus\fP you export metrics from CoreDNS and any plugin that has them. With \fIprometheus\fP you export metrics from CoreDNS and any plugin that has them.
The default location for the metrics is \fB\fClocalhost:9153\fR. The metrics path is fixed to \fB\fC/metrics\fR. The default location for the metrics is \fB\fClocalhost:9153\fR. The metrics path is fixed to \fB\fC/metrics\fR.
...@@ -63,7 +63,7 @@ name "dropped" (without a closing dot - this is never a valid domain name). ...@@ -63,7 +63,7 @@ name "dropped" (without a closing dot - this is never a valid domain name).
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -80,7 +80,7 @@ For each zone that you want to see metrics for. ...@@ -80,7 +80,7 @@ For each zone that you want to see metrics for.
It optionally takes a bind address to which the metrics are exported; the default It optionally takes a bind address to which the metrics are exported; the default
listens on \fB\fClocalhost:9153\fR. The metrics path is fixed to \fB\fC/metrics\fR. listens on \fB\fClocalhost:9153\fR. The metrics path is fixed to \fB\fC/metrics\fR.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Use an alternative listening address: Use an alternative listening address:
...@@ -110,7 +110,7 @@ then: ...@@ -110,7 +110,7 @@ then:
.fi .fi
.RE .RE
.SH BUGS .SH "BUGS"
.PP .PP
When reloading, the Prometheus handler is stopped before the new server instance is started. When reloading, the Prometheus handler is stopped before the new server instance is started.
If that new server fails to start, then the initial server instance is still available and DNS queries still served, If that new server fails to start, then the initial server instance is still available and DNS queries still served,
......
man/coredns-nsid.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-NSID" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-NSID" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fInsid\fP - adds an identifier of this server to each reply. \fInsid\fP - adds an identifier of this server to each reply.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
This plugin implements RFC 5001 This plugin implements RFC 5001
\[la]https://tools.ietf.org/html/rfc5001\[ra] and adds an EDNS0 OPT \[la]https://tools.ietf.org/html/rfc5001\[ra] and adds an EDNS0 OPT
...@@ -15,7 +15,7 @@ see which server was responsible for generating the reply and for debugging. ...@@ -15,7 +15,7 @@ see which server was responsible for generating the reply and for debugging.
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -31,7 +31,7 @@ nsid [DATA] ...@@ -31,7 +31,7 @@ nsid [DATA]
.PP .PP
If \fBDATA\fP is not given, the host's name is used. If \fBDATA\fP is not given, the host's name is used.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Enable nsid: Enable nsid:
...@@ -71,7 +71,7 @@ And now a client with NSID support will see an OPT record with the NSID option: ...@@ -71,7 +71,7 @@ And now a client with NSID support will see an OPT record with the NSID option:
.fi .fi
.RE .RE
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
RFC 5001 RFC 5001
\[la]https://tools.ietf.org/html/rfc5001\[ra] \[la]https://tools.ietf.org/html/rfc5001\[ra]
......
man/coredns-pprof.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-PPROF" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-PPROF" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIpprof\fP - publishes runtime profiling data at endpoints under \fB\fC/debug/pprof\fR. \fIpprof\fP - publishes runtime profiling data at endpoints under \fB\fC/debug/pprof\fR.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
You can visit \fB\fC/debug/pprof\fR on your site for an index of the available endpoints. By default it You can visit \fB\fC/debug/pprof\fR on your site for an index of the available endpoints. By default it
will listen on localhost:6053. will listen on localhost:6053.
...@@ -17,7 +17,7 @@ you use pprof on a live server, consider restricting access or enabling it only ...@@ -17,7 +17,7 @@ you use pprof on a live server, consider restricting access or enabling it only
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -53,7 +53,7 @@ runtime.SetBlockProfileRate ...@@ -53,7 +53,7 @@ runtime.SetBlockProfileRate
profiling entails. profiling entails.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Enable a pprof endpoint: Enable a pprof endpoint:
...@@ -101,7 +101,7 @@ Listen on an all addresses on port 6060, and enable block profiling ...@@ -101,7 +101,7 @@ Listen on an all addresses on port 6060, and enable block profiling
.fi .fi
.RE .RE
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
See Go's pprof documentation See Go's pprof documentation
\[la]https://golang.org/pkg/net/http/pprof/\[ra] and Profiling Go \[la]https://golang.org/pkg/net/http/pprof/\[ra] and Profiling Go
......
man/coredns-ready.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-READY" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-READY" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIready\fP - enables a readiness check HTTP endpoint. \fIready\fP - enables a readiness check HTTP endpoint.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
By enabling \fIready\fP an HTTP endpoint on port 8181 will return 200 OK, when all plugins that are able By enabling \fIready\fP an HTTP endpoint on port 8181 will return 200 OK, when all plugins that are able
to signal readiness have done so. If some are not ready yet the endpoint will return a 503 with the to signal readiness have done so. If some are not ready yet the endpoint will return a 503 with the
...@@ -14,9 +14,11 @@ will not be queried again. ...@@ -14,9 +14,11 @@ will not be queried again.
.PP .PP
Each Server Block that enables the \fIready\fP plugin will have the plugins \fIin that server block\fP Each Server Block that enables the \fIready\fP plugin will have the plugins \fIin that server block\fP
report readiness into the /ready endpoint that runs on the same port. report readiness into the /ready endpoint that runs on the same port. This also means that the
\fIsame\fP plugin with different configurations (in potentialy \fIdifferent\fP Server Blocks) will have
their readiness reported as the union of their respective readinesses.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -29,14 +31,14 @@ ready [ADDRESS] ...@@ -29,14 +31,14 @@ ready [ADDRESS]
.PP .PP
\fIready\fP optionally takes an address; the default is \fB\fC:8181\fR. The path is fixed to \fB\fC/ready\fR. The \fIready\fP optionally takes an address; the default is \fB\fC:8181\fR. The path is fixed to \fB\fC/ready\fR. The
readiness endpoint returns a 200 response code and the word "OK" when this server is ready. It readiness endpoint returns a 200 response code and the word "OK" when this server is ready. It
returns a 503 otherwise. returns a 503 otherwise \fIand\fP the list of plugins that are not ready.
.SH PLUGINS .SH "PLUGINS"
.PP .PP
Any plugin wanting to signal readiness will need to implement the \fB\fCready.Readiness\fR interface by Any plugin wanting to signal readiness will need to implement the \fB\fCready.Readiness\fR interface by
implementing a method \fB\fCReady() bool\fR that returns true when the plugin is ready and false otherwise. implementing a method \fB\fCReady() bool\fR that returns true when the plugin is ready and false otherwise.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Let \fIready\fP report readiness for both the \fB\fC.\fR and \fB\fCexample.org\fR servers (assuming the \fIwhois\fP Let \fIready\fP report readiness for both the \fB\fC.\fR and \fB\fCexample.org\fR servers (assuming the \fIwhois\fP
plugin also exports readiness): plugin also exports readiness):
......
man/coredns-reload.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-RELOAD" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-RELOAD" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIreload\fP - allows automatic reload of a changed Corefile. \fIreload\fP - allows automatic reload of a changed Corefile.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
This plugin allows automatic reload of a changed \fICorefile\fP. This plugin allows automatic reload of a changed \fICorefile\fP.
To enable automatic reloading of \fIzone file\fP changes, use the \fB\fCauto\fR plugin. To enable automatic reloading of \fIzone file\fP changes, use the \fB\fCauto\fR plugin.
...@@ -38,7 +38,7 @@ Jitter is re-calculated whenever the Corefile is reloaded. ...@@ -38,7 +38,7 @@ Jitter is re-calculated whenever the Corefile is reloaded.
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -61,7 +61,7 @@ Minimal value for \fBINTERVAL\fP is 2s, and for \fBJITTER\fP is 1s ...@@ -61,7 +61,7 @@ Minimal value for \fBINTERVAL\fP is 2s, and for \fBJITTER\fP is 1s
If \fBJITTER\fP is more than half of \fBINTERVAL\fP, it will be set to half of \fBINTERVAL\fP If \fBJITTER\fP is more than half of \fBINTERVAL\fP, it will be set to half of \fBINTERVAL\fP
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Check with the default intervals: Check with the default intervals:
...@@ -92,7 +92,7 @@ Check every 10 seconds (jitter is automatically set to 10 / 2 = 5 in this case): ...@@ -92,7 +92,7 @@ Check every 10 seconds (jitter is automatically set to 10 / 2 = 5 in this case):
.fi .fi
.RE .RE
.SH BUGS .SH "BUGS"
.PP .PP
The reload happens without data loss (i.e. DNS queries keep flowing), but there is a corner case The reload happens without data loss (i.e. DNS queries keep flowing), but there is a corner case
where the reload fails, and you loose functionality. Consider the following Corefile: where the reload fails, and you loose functionality. Consider the following Corefile:
...@@ -134,7 +134,7 @@ In general be careful with assigning new port and expecting reload to work fully ...@@ -134,7 +134,7 @@ In general be careful with assigning new port and expecting reload to work fully
Also any \fB\fCimport\fR statement is not discovered by this plugin. This means if any of these imported files Also any \fB\fCimport\fR statement is not discovered by this plugin. This means if any of these imported files
changes the \fIreload\fP plugin is ignorant of that fact. changes the \fIreload\fP plugin is ignorant of that fact.
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
See coredns-import(7) and corefile(5). See coredns-import(7) and corefile(5).
man/coredns-rewrite.7
View file @ 51cf388d
This diff is collapsed.
man/coredns-root.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-ROOT" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-ROOT" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIroot\fP - simply specifies the root of where to find (zone) files. \fIroot\fP - simply specifies the root of where to find (zone) files.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The default root is the current working directory of CoreDNS. The \fIroot\fP plugin allows you to change The default root is the current working directory of CoreDNS. The \fIroot\fP plugin allows you to change
this. A relative root path is relative to the current working directory. this. A relative root path is relative to the current working directory.
...@@ -13,7 +13,7 @@ this. A relative root path is relative to the current working directory. ...@@ -13,7 +13,7 @@ this. A relative root path is relative to the current working directory.
.PP .PP
This plugin can only be used once per Server Block. This plugin can only be used once per Server Block.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -26,7 +26,7 @@ root PATH ...@@ -26,7 +26,7 @@ root PATH
.PP .PP
\fBPATH\fP is the directory to set as CoreDNS' root. \fBPATH\fP is the directory to set as CoreDNS' root.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Serve zone data (when the \fIfile\fP plugin is used) from \fB\fC/etc/coredns/zones\fR: Serve zone data (when the \fIfile\fP plugin is used) from \fB\fC/etc/coredns/zones\fR:
......
man/coredns-secondary.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-SECONDARY" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-SECONDARY" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIsecondary\fP - enables serving a zone retrieved from a primary server. \fIsecondary\fP - enables serving a zone retrieved from a primary server.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
With \fIsecondary\fP you can transfer (via AXFR) a zone from another server. The retrieved zone is With \fIsecondary\fP you can transfer (via AXFR) a zone from another server. The retrieved zone is
\fInot committed\fP to disk (a violation of the RFC). This means restarting CoreDNS will cause it to \fInot committed\fP to disk (a violation of the RFC). This means restarting CoreDNS will cause it to
...@@ -57,7 +57,7 @@ When a zone is due to be refreshed (Refresh timer fires) a random jitter of 5 se ...@@ -57,7 +57,7 @@ When a zone is due to be refreshed (Refresh timer fires) a random jitter of 5 se
applied, before fetching. In the case of retry this will be 2 seconds. If there are any errors applied, before fetching. In the case of retry this will be 2 seconds. If there are any errors
during the transfer the transfer fails; this will be logged. during the transfer the transfer fails; this will be logged.
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Transfer \fB\fCexample.org\fR from 10.0.1.1, and if that fails try 10.1.2.1. Transfer \fB\fCexample.org\fR from 10.0.1.1, and if that fails try 10.1.2.1.
...@@ -92,7 +92,7 @@ Or re-export the retrieved zone to other secondaries. ...@@ -92,7 +92,7 @@ Or re-export the retrieved zone to other secondaries.
.fi .fi
.RE .RE
.SH BUGS .SH "BUGS"
.PP .PP
Only AXFR is supported and the retrieved zone is not committed to disk. Only AXFR is supported and the retrieved zone is not committed to disk.
man/coredns-template.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-TEMPLATE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-TEMPLATE" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fItemplate\fP - allows for dynamic responses based on the incoming query. \fItemplate\fP - allows for dynamic responses based on the incoming query.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fItemplate\fP plugin allows you to dynamically respond to queries by just writing a (Go) template. The \fItemplate\fP plugin allows you to dynamically respond to queries by just writing a (Go) template.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -58,7 +58,7 @@ At least one \fB\fCanswer\fR or \fB\fCrcode\fR directive is needed (e.g. \fB\fCr ...@@ -58,7 +58,7 @@ At least one \fB\fCanswer\fR or \fB\fCrcode\fR directive is needed (e.g. \fB\fCr
Also see Also see
\[la]#also-see\[ra] contains an additional reading list. \[la]#also-see\[ra] contains an additional reading list.
.SH TEMPLATES .SH "TEMPLATES"
.PP .PP
Each resource record is a full-featured Go template Each resource record is a full-featured Go template
\[la]https://golang.org/pkg/text/template/\[ra] with the following predefined data \[la]https://golang.org/pkg/text/template/\[ra] with the following predefined data
...@@ -91,7 +91,7 @@ The output of the template must be a RFC 1035 ...@@ -91,7 +91,7 @@ The output of the template must be a RFC 1035
Caddy) while \fB\fC{{ $var }}\fR will work. See Bugs Caddy) while \fB\fC{{ $var }}\fR will work. See Bugs
\[la]#bugs\[ra] and corefile(5). \[la]#bugs\[ra] and corefile(5).
.SH METRICS .SH "METRICS"
.PP .PP
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported: If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported:
...@@ -107,8 +107,8 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following ...@@ -107,8 +107,8 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following
Both failure cases indicate a problem with the template configuration. The \fB\fCserver\fR label indicates Both failure cases indicate a problem with the template configuration. The \fB\fCserver\fR label indicates
the server incrementing the metric, see the \fImetrics\fP plugin for details. the server incrementing the metric, see the \fImetrics\fP plugin for details.
.SH EXAMPLES .SH "EXAMPLES"
.SS RESOLVE EVERYTHING TO NXDOMAIN .SS "RESOLVE EVERYTHING TO NXDOMAIN"
.PP .PP
The most simplistic template is The most simplistic template is
...@@ -133,7 +133,7 @@ All queries will be answered (no \fB\fCfallthrough\fR) ...@@ -133,7 +133,7 @@ All queries will be answered (no \fB\fCfallthrough\fR)
The answer is always NXDOMAIN The answer is always NXDOMAIN
.SS RESOLVE .INVALID AS NXDOMAIN .SS "RESOLVE .INVALID AS NXDOMAIN"
.PP .PP
The \fB\fC.invalid\fR domain is a reserved TLD (see RFC 2606 Reserved Top Level DNS Names The \fB\fC.invalid\fR domain is a reserved TLD (see RFC 2606 Reserved Top Level DNS Names
\[la]https://tools.ietf.org/html/rfc2606#section-2\[ra]) to indicate invalid domains. \[la]https://tools.ietf.org/html/rfc2606#section-2\[ra]) to indicate invalid domains.
...@@ -164,7 +164,7 @@ Querying \fB\fC.invalid\fR in the \fB\fCCH\fR class will also cause a NXDOMAIN/S ...@@ -164,7 +164,7 @@ Querying \fB\fC.invalid\fR in the \fB\fCCH\fR class will also cause a NXDOMAIN/S
The default regex is \fB\fC.*\fR The default regex is \fB\fC.*\fR
.SS BLOCK INVALID SEARCH DOMAIN COMPLETIONS .SS "BLOCK INVALID SEARCH DOMAIN COMPLETIONS"
.PP .PP
Imagine you run \fB\fCexample.com\fR with a datacenter \fB\fCdc1.example.com\fR. The datacenter domain Imagine you run \fB\fCexample.com\fR with a datacenter \fB\fCdc1.example.com\fR. The datacenter domain
is part of the DNS search domain. is part of the DNS search domain.
...@@ -212,7 +212,7 @@ A more verbose regex based equivalent would be ...@@ -212,7 +212,7 @@ A more verbose regex based equivalent would be
.PP .PP
The regex-based version can do more complex matching/templating while zone-based templating is easier to read and use. The regex-based version can do more complex matching/templating while zone-based templating is easier to read and use.
.SS RESOLVE A/PTR FOR .EXAMPLE .SS "RESOLVE A/PTR FOR .EXAMPLE"
.PP .PP
.RS .RS
...@@ -252,7 +252,7 @@ Having templates to map certain PTR/A pairs is a common pattern. ...@@ -252,7 +252,7 @@ Having templates to map certain PTR/A pairs is a common pattern.
.PP .PP
Fallthrough is needed for mixed domains where only some responses are templated. Fallthrough is needed for mixed domains where only some responses are templated.
.SS RESOLVE MULTIPLE IP PATTERNS .SS "RESOLVE MULTIPLE IP PATTERNS"
.PP .PP
.RS .RS
...@@ -274,7 +274,7 @@ Fallthrough is needed for mixed domains where only some responses are templated. ...@@ -274,7 +274,7 @@ Fallthrough is needed for mixed domains where only some responses are templated.
.PP .PP
Named capture groups can be used to template one response for multiple patterns. Named capture groups can be used to template one response for multiple patterns.
.SS RESOLVE A AND MX RECORDS FOR IP TEMPLATES IN .EXAMPLE .SS "RESOLVE A AND MX RECORDS FOR IP TEMPLATES IN .EXAMPLE"
.PP .PP
.RS .RS
...@@ -298,7 +298,7 @@ Named capture groups can be used to template one response for multiple patterns. ...@@ -298,7 +298,7 @@ Named capture groups can be used to template one response for multiple patterns.
.fi .fi
.RE .RE
.SS ADDING AUTHORITATIVE NAMESERVERS TO THE RESPONSE .SS "ADDING AUTHORITATIVE NAMESERVERS TO THE RESPONSE"
.PP .PP
.RS .RS
...@@ -330,7 +330,7 @@ Named capture groups can be used to template one response for multiple patterns. ...@@ -330,7 +330,7 @@ Named capture groups can be used to template one response for multiple patterns.
.fi .fi
.RE .RE
.SH ALSO SEE .SH "ALSO SEE"
.IP \(bu 4 .IP \(bu 4
Go regexp Go regexp
\[la]https://golang.org/pkg/regexp/\[ra] for details about the regex implementation \[la]https://golang.org/pkg/regexp/\[ra] for details about the regex implementation
...@@ -346,7 +346,7 @@ Go template ...@@ -346,7 +346,7 @@ Go template
\[la]https://golang.org/pkg/text/template/\[ra] for the template language reference \[la]https://golang.org/pkg/text/template/\[ra] for the template language reference
.SH BUGS .SH "BUGS"
.PP .PP
CoreDNS supports caddyfile environment variables CoreDNS supports caddyfile environment variables
\[la]https://caddyserver.com/docs/caddyfile#env\[ra] \[la]https://caddyserver.com/docs/caddyfile#env\[ra]
......
man/coredns-tls.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-TLS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-TLS" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fItls\fP - allows you to configure the server certificates for the TLS and gRPC servers. \fItls\fP - allows you to configure the server certificates for the TLS and gRPC servers.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
CoreDNS supports queries that are encrypted using TLS (DNS over Transport Layer Security, RFC 7858) CoreDNS supports queries that are encrypted using TLS (DNS over Transport Layer Security, RFC 7858)
or are using gRPC (https://grpc.io/ or are using gRPC (https://grpc.io/
...@@ -20,7 +20,7 @@ DNS-over-TLS and DNS-over-gRPC. If the \fB\fCtls\fR directive is omitted, then n ...@@ -20,7 +20,7 @@ DNS-over-TLS and DNS-over-gRPC. If the \fB\fCtls\fR directive is omitted, then n
The gRPC protobuffer is defined in \fB\fCpb/dns.proto\fR. It defines the proto as a simple wrapper for the The gRPC protobuffer is defined in \fB\fCpb/dns.proto\fR. It defines the proto as a simple wrapper for the
wire data of a DNS message. wire data of a DNS message.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -33,7 +33,24 @@ tls CERT KEY [CA] ...@@ -33,7 +33,24 @@ tls CERT KEY [CA]
.PP .PP
Parameter CA is optional. If not set, system CAs can be used to verify the client certificate Parameter CA is optional. If not set, system CAs can be used to verify the client certificate
.SH EXAMPLES .PP
.RS
.nf
tls CERT KEY [CA] {
client\_auth nocert|request|require|verify\_if\_given|require\_and\_verify
}
.fi
.RE
.PP
If client\fIauth option is specified, it controls the client authentication policy.
The option value corresponds to the ClientAuthType values of the Go tls package
\[la]https://golang.org/pkg/crypto/tls/#ClientAuthType\[ra]: NoClientCert, RequestClientCert, RequireAnyClientCert, VerifyClientCertIfGiven, and RequireAndVerifyClientCert, respectively.
The default is "nocert". Note that it makes no sense to specify parameter CA unless this option is set to verify\fPif\fIgiven or require\fPand_verify.
.SH "EXAMPLES"
.PP .PP
Start a DNS-over-TLS server that picks up incoming DNS-over-TLS queries on port 5553 and uses the Start a DNS-over-TLS server that picks up incoming DNS-over-TLS queries on port 5553 and uses the
nameservers defined in \fB\fC/etc/resolv.conf\fR to resolve the query. This proxy path uses plain old DNS. nameservers defined in \fB\fC/etc/resolv.conf\fR to resolve the query. This proxy path uses plain old DNS.
...@@ -70,7 +87,7 @@ grpc://. { ...@@ -70,7 +87,7 @@ grpc://. {
Only Knot DNS' \fB\fCkdig\fR supports DNS-over-TLS queries, no command line client supports gRPC making Only Knot DNS' \fB\fCkdig\fR supports DNS-over-TLS queries, no command line client supports gRPC making
debugging these transports harder than it should be. debugging these transports harder than it should be.
.SH ALSO SEE .SH "ALSO SEE"
.PP .PP
RFC 7858 and https://grpc.io RFC 7858 and https://grpc.io
\[la]https://grpc.io\[ra]. \[la]https://grpc.io\[ra].
......
man/coredns-trace.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-TRACE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-TRACE" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fItrace\fP - enables OpenTracing-based tracing of DNS requests as they go through the plugin chain. \fItrace\fP - enables OpenTracing-based tracing of DNS requests as they go through the plugin chain.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
With \fItrace\fP you enable OpenTracing of how a request flows through CoreDNS. With \fItrace\fP you enable OpenTracing of how a request flows through CoreDNS.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
The simplest form is just: The simplest form is just:
...@@ -59,7 +59,7 @@ Default is \fB\fCcoredns\fR. ...@@ -59,7 +59,7 @@ Default is \fB\fCcoredns\fR.
\fB\fCclient_server\fR will enable the \fB\fCClientServerSameSpan\fR OpenTracing feature. \fB\fCclient_server\fR will enable the \fB\fCClientServerSameSpan\fR OpenTracing feature.
.SH ZIPKIN .SH "ZIPKIN"
.PP .PP
You can run Zipkin on a Docker host like this: You can run Zipkin on a Docker host like this:
...@@ -72,7 +72,7 @@ docker run \-d \-p 9411:9411 openzipkin/zipkin ...@@ -72,7 +72,7 @@ docker run \-d \-p 9411:9411 openzipkin/zipkin
.fi .fi
.RE .RE
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Use an alternative Zipkin address: Use an alternative Zipkin address:
......
man/coredns-whoami.7
View file @ 51cf388d
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-WHOAMI" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-WHOAMI" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME .SH "NAME"
.PP .PP
\fIwhoami\fP - returns your resolver's local IP address, port and transport. \fIwhoami\fP - returns your resolver's local IP address, port and transport.
.SH DESCRIPTION .SH "DESCRIPTION"
.PP .PP
The \fIwhoami\fP plugin is not really that useful, but can be used for having a simple (fast) endpoint The \fIwhoami\fP plugin is not really that useful, but can be used for having a simple (fast) endpoint
to test clients against. When \fIwhoami\fP returns a response it will have your client's IP address in to test clients against. When \fIwhoami\fP returns a response it will have your client's IP address in
...@@ -32,7 +32,7 @@ If CoreDNS can't find a Corefile on startup this is the \fIdefault\fP plugin tha ...@@ -32,7 +32,7 @@ If CoreDNS can't find a Corefile on startup this is the \fIdefault\fP plugin tha
it can be used to check that CoreDNS is responding to queries. Other than that this plugin is of it can be used to check that CoreDNS is responding to queries. Other than that this plugin is of
limited use in production. limited use in production.
.SH SYNTAX .SH "SYNTAX"
.PP .PP
.RS .RS
...@@ -42,7 +42,7 @@ whoami ...@@ -42,7 +42,7 @@ whoami
.fi .fi
.RE .RE
.SH EXAMPLES .SH "EXAMPLES"
.PP .PP
Start a server on the default port and load the \fIwhoami\fP plugin. Start a server on the default port and load the \fIwhoami\fP plugin.
...@@ -74,7 +74,7 @@ example.org. 0 IN A 10.240.0.1 ...@@ -74,7 +74,7 @@ example.org. 0 IN A 10.240.0.1
.fi .fi
.RE .RE
.SH SEE ALSO .SH "SEE ALSO"
.PP .PP
Read the blog post Read the blog post
\[la]https://coredns.io/2017/03/01/how-to-add-plugins-to-coredns/\[ra] on how this plugin is built, or explore the source code \[la]https://coredns.io/2017/03/01/how-to-add-plugins-to-coredns/\[ra] on how this plugin is built, or explore the source code
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment