docs: make -f Makefile.doc (#1589)
Mechanical change; ran the above command.
This commit is contained in:
parent
804f745951
commit
369bde5adc
31 changed files with 125 additions and 64 deletions
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-BIND" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-BIND" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIbind\fR \- overrides the host to which the server should bind\.
|
\fIbind\fR \- overrides the host to which the server should bind\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-CACHE" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-CACHE" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIcache\fR \- enables a frontend cache\.
|
\fIcache\fR \- enables a frontend cache\.
|
||||||
|
@ -9,6 +9,9 @@
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
With \fIcache\fR 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, database, etc\.) is expensive\.
|
With \fIcache\fR 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, database, etc\.) is expensive\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-CHAOS" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-CHAOS" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIchaos\fR \- allows for responding to TXT queries in the CH class\.
|
\fIchaos\fR \- allows for responding to TXT queries in the CH class\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-DEBUG" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-DEBUG" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIdebug\fR \- disables the automatic recovery upon a crash so that you\'ll get a nice stack trace\.
|
\fIdebug\fR \- disables the automatic recovery upon a crash so that you\'ll get a nice stack trace\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-DNSSEC" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-DNSSEC" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIdnssec\fR \- enable on\-the\-fly DNSSEC signing of served data\.
|
\fIdnssec\fR \- enable on\-the\-fly DNSSEC signing of served data\.
|
||||||
|
@ -9,6 +9,9 @@
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
With \fIdnssec\fR 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 this leads to smaller signatures (compared to RSA)\. NSEC3 is \fInot\fR supported\.
|
With \fIdnssec\fR 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 this leads to smaller signatures (compared to RSA)\. NSEC3 is \fInot\fR supported\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
@ -101,25 +104,4 @@ cluster\.local {
|
||||||
.fi
|
.fi
|
||||||
.
|
.
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.SH "BUGS"
|
|
||||||
Multiple \fIdnssec\fR plugins inside one server stanza will silently overwrite earlier ones, here \fBexample\.org\fR will overwrite the one for \fBcluster\.local\fR\.
|
|
||||||
.
|
|
||||||
.IP "" 4
|
|
||||||
.
|
|
||||||
.nf
|
|
||||||
|
|
||||||
\&\. {
|
|
||||||
kubernetes cluster\.local
|
|
||||||
dnssec cluster\.local {
|
|
||||||
key file Kcluster\.local+013+45129
|
|
||||||
}
|
|
||||||
dnssec example\.org {
|
|
||||||
key file Kexample\.org\.+013+45330
|
|
||||||
}
|
|
||||||
}
|
|
||||||
.
|
|
||||||
.fi
|
|
||||||
.
|
|
||||||
.IP "" 0
|
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-DNSTAP" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-DNSTAP" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIdnstap\fR \- enable logging to dnstap
|
\fIdnstap\fR \- enable logging to dnstap
|
||||||
|
@ -77,7 +77,7 @@ The following command listens on the given socket and decodes messages to stdout
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
% dnstap \-u /tmp/dnstap\.sock
|
$ dnstap \-u /tmp/dnstap\.sock
|
||||||
.
|
.
|
||||||
.fi
|
.fi
|
||||||
.
|
.
|
||||||
|
@ -90,7 +90,7 @@ The following command listens on the given socket and saves message payloads to
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
% dnstap \-u /tmp/dnstap\.sock \-w /tmp/test\.dnstap
|
$ dnstap \-u /tmp/dnstap\.sock \-w /tmp/test\.dnstap
|
||||||
.
|
.
|
||||||
.fi
|
.fi
|
||||||
.
|
.
|
||||||
|
@ -103,11 +103,37 @@ Listen for dnstap messages on port 6000\.
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
% dnstap \-l 127\.0\.0\.1:6000
|
$ dnstap \-l 127\.0\.0\.1:6000
|
||||||
.
|
.
|
||||||
.fi
|
.fi
|
||||||
.
|
.
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
.
|
||||||
|
.SH "USING DNSTAP IN YOUR PLUGIN"
|
||||||
|
.
|
||||||
|
.nf
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github\.com/coredns/coredns/plugin/dnstap"
|
||||||
|
"github\.com/coredns/coredns/plugin/dnstap/msg"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (h Dnstap) ServeDNS(ctx context\.Context, w dns\.ResponseWriter, r *dns\.Msg) (int, error) {
|
||||||
|
// log client query to Dnstap
|
||||||
|
if t := dnstap\.TapperFromContext(ctx); t != nil {
|
||||||
|
b := msg\.New()\.Time(time\.Now())\.Addr(w\.RemoteAddr())
|
||||||
|
if t\.Pack() {
|
||||||
|
b\.Msg(r)
|
||||||
|
}
|
||||||
|
if m, err := b\.ToClientQuery(); err == nil {
|
||||||
|
t\.TapMessage(m)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// \.\.\.
|
||||||
|
}
|
||||||
|
.
|
||||||
|
.fi
|
||||||
|
.
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
dnstap\.info \fIhttp://dnstap\.info\fR\.
|
dnstap\.info \fIhttp://dnstap\.info\fR\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-ERRATIC" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-ERRATIC" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIerratic\fR \- a plugin useful for testing client behavior\.
|
\fIerratic\fR \- a plugin useful for testing client behavior\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-ERRORS" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-ERRORS" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIerrors\fR \- enable error logging\.
|
\fIerrors\fR \- enable error logging\.
|
||||||
|
@ -9,6 +9,9 @@
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
Any errors encountered during the query processing will be printed to standard output\.
|
Any errors encountered during the query processing will be printed to standard output\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-ETCD" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-ETCD" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIetcd\fR \- enables reading zone data from an etcd instance\.
|
\fIetcd\fR \- enables reading zone data from an etcd instance\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-FEDERATION" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-FEDERATION" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIfederation\fR \- enables federated queries to be resolved via the kubernetes plugin\.
|
\fIfederation\fR \- enables federated queries to be resolved via the kubernetes plugin\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-FILE" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-FILE" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIfile\fR \- enables serving zone data from an RFC 1035\-style master file\.
|
\fIfile\fR \- enables serving zone data from an RFC 1035\-style master file\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-FORWARD" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-FORWARD" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIforward\fR \- facilitates proxying DNS messages to upstream resolvers\.
|
\fIforward\fR \- facilitates proxying DNS messages to upstream resolvers\.
|
||||||
|
@ -15,6 +15,9 @@ When it detects an error a health check is performed\. This checks runs in a loo
|
||||||
.P
|
.P
|
||||||
When \fIall\fR upstreams are down it assumes health checking as a mechanism has failed and will try to connect to a random upstream (which may or may not work)\.
|
When \fIall\fR upstreams are down it assumes health checking as a mechanism has failed and will try to connect to a random upstream (which may or may not work)\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
In its most basic form, a simple forwarder uses this syntax:
|
In its most basic form, a simple forwarder uses this syntax:
|
||||||
.
|
.
|
||||||
|
@ -54,7 +57,7 @@ forward FROM TO\.\.\. {
|
||||||
tls CERT KEY CA
|
tls CERT KEY CA
|
||||||
tls_servername NAME
|
tls_servername NAME
|
||||||
policy random|round_robin
|
policy random|round_robin
|
||||||
health_checks DURATION
|
health_check DURATION
|
||||||
}
|
}
|
||||||
.
|
.
|
||||||
.fi
|
.fi
|
||||||
|
@ -86,7 +89,7 @@ forward FROM TO\.\.\. {
|
||||||
\fBpolicy\fR specifies the policy to use for selecting upstream servers\. The default is \fBrandom\fR\.
|
\fBpolicy\fR specifies the policy to use for selecting upstream servers\. The default is \fBrandom\fR\.
|
||||||
.
|
.
|
||||||
.IP "\(bu" 4
|
.IP "\(bu" 4
|
||||||
\fBhealth_checks\fR, use a different \fBDURATION\fR for health checking, the default duration is 0\.5s\.
|
\fBhealth_check\fR, use a different \fBDURATION\fR for health checking, the default duration is 0\.5s\.
|
||||||
.
|
.
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-HEALTH" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-HEALTH" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIhealth\fR \- enables a health check endpoint\.
|
\fIhealth\fR \- enables a health check endpoint\.
|
||||||
.
|
.
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
By enabling \fIhealth\fR any plugin that implements it will be queried for it\'s health\. The combined health is exported, by default, on port 8080/health \.
|
By enabling \fIhealth\fR any plugin that implements healt\.Healther interface \fIhttps://godoc\.org/github\.com/coredns/coredns/plugin/health#Healther\fR will be queried for it\'s health\. The combined health is exported, by default, on port 8080/health \.
|
||||||
.
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
|
@ -40,6 +40,27 @@ Where \fBlameduck\fR will make the process unhealthy then \fIwait\fR for \fBDURA
|
||||||
.
|
.
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
If you have multiple Server Block and need to export health for each of the plugins, you must run health endpoints on different ports:
|
||||||
|
.
|
||||||
|
.IP "" 4
|
||||||
|
.
|
||||||
|
.nf
|
||||||
|
|
||||||
|
com {
|
||||||
|
whoami
|
||||||
|
health :8080
|
||||||
|
}
|
||||||
|
|
||||||
|
net {
|
||||||
|
erratic
|
||||||
|
health :8081
|
||||||
|
}
|
||||||
|
.
|
||||||
|
.fi
|
||||||
|
.
|
||||||
|
.IP "" 0
|
||||||
|
.
|
||||||
.SH "PLUGINS"
|
.SH "PLUGINS"
|
||||||
Any plugin that implements the Healther interface will be used to report health\.
|
Any plugin that implements the Healther interface will be used to report health\.
|
||||||
.
|
.
|
||||||
|
@ -47,7 +68,7 @@ Any plugin that implements the Healther interface will be used to report health\
|
||||||
If monitoring is enabled (via the \fIprometheus\fR directive) then the following metric is exported:
|
If monitoring is enabled (via the \fIprometheus\fR directive) then the following metric is exported:
|
||||||
.
|
.
|
||||||
.IP "\(bu" 4
|
.IP "\(bu" 4
|
||||||
\fBcoredns_health_request_duration_seconds{}\fR \- duration to process a /health query\. As this should be a local operation it should be fast\. A (large) increases in this duration indicates the CoreDNS process is having trouble keeping up\.
|
\fBcoredns_health_request_duration_seconds{}\fR \- duration to process a /health query\. As this should be a local operation it should be fast\. A (large) increases in this duration indicates the CoreDNS process is having trouble keeping up with its query load\.
|
||||||
.
|
.
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
.
|
||||||
|
@ -74,7 +95,7 @@ Set a lameduck duration of 1 second:
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
\&\. {
|
\&\. {
|
||||||
health localhost:8091 {
|
health localhost:8092 {
|
||||||
lameduck 1s
|
lameduck 1s
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-HOSTS" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-HOSTS" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIhosts\fR \- enables serving zone data from a \fB/etc/hosts\fR style file\.
|
\fIhosts\fR \- enables serving zone data from a \fB/etc/hosts\fR style file\.
|
||||||
|
@ -9,6 +9,9 @@
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
The hosts plugin is useful for serving zones from a /etc/hosts file\. It serves from a preloaded file that exists on disk\. It checks the file for changes and updates the zones accordingly\. This plugin only supports A, AAAA, and PTR records\. The hosts plugin can be used with readily available hosts files that block access to advertising servers\.
|
The hosts plugin is useful for serving zones from a /etc/hosts file\. It serves from a preloaded file that exists on disk\. It checks the file for changes and updates the zones accordingly\. This plugin only supports A, AAAA, and PTR records\. The hosts plugin can be used with readily available hosts files that block access to advertising servers\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-KUBERNETES" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-KUBERNETES" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIkubernetes\fR \- enables the reading zone data from a Kubernetes cluster\.
|
\fIkubernetes\fR \- enables the reading zone data from a Kubernetes cluster\.
|
||||||
|
@ -15,6 +15,9 @@ CoreDNS running the kubernetes plugin can be used as a replacement of kube\-dns
|
||||||
.P
|
.P
|
||||||
stubDomains and upstreamNameservers \fIhttp://blog\.kubernetes\.io/2017/04/configuring\-private\-dns\-zones\-upstream\-nameservers\-kubernetes\.html\fR are implemented via the \fIproxy\fR plugin and kubernetes \fIupstream\fR\. See example below\.
|
stubDomains and upstreamNameservers \fIhttp://blog\.kubernetes\.io/2017/04/configuring\-private\-dns\-zones\-upstream\-nameservers\-kubernetes\.html\fR are implemented via the \fIproxy\fR plugin and kubernetes \fIupstream\fR\. See example below\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-LOADBALANCE" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-LOADBALANCE" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIloadbalance\fR \- acts as a round\-robin DNS loadbalancer by randomizing the order of A and AAAA records in the answer\.
|
\fIloadbalance\fR \- acts as a round\-robin DNS loadbalancer by randomizing the order of A and AAAA records in the answer\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-LOG" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-LOG" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIlog\fR \- enables query logging to standard output\.
|
\fIlog\fR \- enables query logging to standard output\.
|
||||||
|
@ -103,7 +103,7 @@ The following place holders are supported:
|
||||||
\fB{when}\fR: time of the query
|
\fB{when}\fR: time of the query
|
||||||
.
|
.
|
||||||
.IP "\(bu" 4
|
.IP "\(bu" 4
|
||||||
\fB{remote}\fR: client\'s IP address
|
\fB{remote}\fR: client\'s IP address, for IPv6 addresses these are enclosed in brackets: \fB[::1]\fR
|
||||||
.
|
.
|
||||||
.IP "\(bu" 4
|
.IP "\(bu" 4
|
||||||
\fB{size}\fR: request size in bytes
|
\fB{size}\fR: request size in bytes
|
||||||
|
@ -144,7 +144,7 @@ The default Common Log Format is:
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
`{remote} \- [{when}] {>id} "{type} {class} {name} {proto} {size} {>do} {>bufsize}" {rcode} {>rflags} {rsize} {duration}`
|
`{remote}:{port} \- [{when}] {>id} "{type} {class} {name} {proto} {size} {>do} {>bufsize}" {rcode} {>rflags} {rsize} {duration}`
|
||||||
.
|
.
|
||||||
.fi
|
.fi
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-METRICS" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-METRICS" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIprometheus\fR \- enables Prometheus \fIhttps://prometheus\.io/\fR metrics\.
|
\fIprometheus\fR \- enables Prometheus \fIhttps://prometheus\.io/\fR metrics\.
|
||||||
|
@ -58,6 +58,9 @@ The \fBresponse_rcode_count_total\fR has an extra label \fBrcode\fR which holds
|
||||||
.P
|
.P
|
||||||
If monitoring is enabled, queries that do not enter the plugin chain are exported under the fake name "dropped" (without a closing dot \- this is never a valid domain name)\.
|
If monitoring is enabled, queries that do not enter the plugin chain are exported under the fake name "dropped" (without a closing dot \- this is never a valid domain name)\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
|
@ -1,13 +1,16 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-NSID" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-NSID" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fInsid\fR \- adds an identifier of this server to each reply\.
|
\fInsid\fR \- adds an identifier of this server to each reply\.
|
||||||
.
|
.
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
This plugin implements RFC 5001 and adds an EDNS0 OPT resource record to replies that uniquely identify the server\. This is useful in anycast setups to see which server was responsible for generating the reply and for debugging\.
|
This plugin implements RFC 5001 \fIhttps://tools\.ietf\.org/html/rfc5001\fR and adds an EDNS0 OPT resource record to replies that uniquely identify the server\. This is useful in anycast setups to see which server was responsible for generating the reply and for debugging\.
|
||||||
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
.
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
|
@ -63,4 +66,6 @@ And now a client with NSID support will see an OPT record with the NSID option:
|
||||||
.fi
|
.fi
|
||||||
.
|
.
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
|
.
|
||||||
|
.SH "ALSO SEE"
|
||||||
|
RFC 5001 \fIhttps://tools\.ietf\.org/html/rfc5001\fR
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-PPROF" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-PPROF" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIpprof\fR \- publishes runtime profiling data at endpoints under \fB/debug/pprof\fR\.
|
\fIpprof\fR \- publishes runtime profiling data at endpoints under \fB/debug/pprof\fR\.
|
||||||
|
@ -12,6 +12,9 @@ You can visit \fB/debug/pprof\fR on your site for an index of the available endp
|
||||||
.P
|
.P
|
||||||
For more information, please see Go\'s pprof documentation \fIhttps://golang\.org/pkg/net/http/pprof/\fR and read Profiling Go Programs \fIhttps://blog\.golang\.org/profiling\-go\-programs\fR\.
|
For more information, please see Go\'s pprof documentation \fIhttps://golang\.org/pkg/net/http/pprof/\fR and read Profiling Go Programs \fIhttps://blog\.golang\.org/profiling\-go\-programs\fR\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-PROXY" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-PROXY" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIproxy\fR \- facilitates both a basic reverse proxy and a robust load balancer\.
|
\fIproxy\fR \- facilitates both a basic reverse proxy and a robust load balancer\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-RELOAD" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-RELOAD" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIreload\fR \- allows automatic reload of a changed Corefile
|
\fIreload\fR \- allows automatic reload of a changed Corefile
|
||||||
|
@ -18,6 +18,9 @@ In some environments (for example, Kubernetes), there may be many CoreDNS instan
|
||||||
.P
|
.P
|
||||||
Jitter is re\-calculated whenever the Corefile is reloaded\.
|
Jitter is re\-calculated whenever the Corefile is reloaded\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-REVERSE" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-REVERSE" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIreverse\fR \- allows for dynamic responses to PTR and the related A/AAAA requests\.
|
\fIreverse\fR \- allows for dynamic responses to PTR and the related A/AAAA requests\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-REWRITE" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-REWRITE" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIrewrite\fR \- performs internal message rewriting\.
|
\fIrewrite\fR \- performs internal message rewriting\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-ROOT" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-ROOT" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIroot\fR \- simply specifies the root of where to find (zone) files\.
|
\fIroot\fR \- simply specifies the root of where to find (zone) files\.
|
||||||
|
@ -9,6 +9,9 @@
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
The default root is the current working directory of CoreDNS\. The \fIroot\fR plugin allows you to change this\. A relative root path is relative to the current working directory\.
|
The default root is the current working directory of CoreDNS\. The \fIroot\fR plugin allows you to change this\. A relative root path is relative to the current working directory\.
|
||||||
.
|
.
|
||||||
|
.P
|
||||||
|
This plugin can only be used once per Server Block\.
|
||||||
|
.
|
||||||
.SH "SYNTAX"
|
.SH "SYNTAX"
|
||||||
.
|
.
|
||||||
.nf
|
.nf
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-ROUTE53" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-ROUTE53" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIroute53\fR \- enables serving zone data from AWS route53\.
|
\fIroute53\fR \- enables serving zone data from AWS route53\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-SECONDARY" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-SECONDARY" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIsecondary\fR \- enables serving a zone retrieved from a primary server\.
|
\fIsecondary\fR \- enables serving a zone retrieved from a primary server\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-TEMPLATE" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-TEMPLATE" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fItemplate\fR \- allows for dynamic responses based on the incoming query\.
|
\fItemplate\fR \- allows for dynamic responses based on the incoming query\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-TLS" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-TLS" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fItls\fR \- allows you to configure the server certificates for the TLS and gRPC servers\.
|
\fItls\fR \- allows you to configure the server certificates for the TLS and gRPC servers\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-TRACE" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-TRACE" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fItrace\fR \- enables OpenTracing\-based tracing of DNS requests as they go through the plugin chain\.
|
\fItrace\fR \- enables OpenTracing\-based tracing of DNS requests as they go through the plugin chain\.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "COREDNS\-WHOAMI" "7" "February 2018" "CoreDNS" "CoreDNS plugins"
|
.TH "COREDNS\-WHOAMI" "7" "March 2018" "CoreDNS" "CoreDNS plugins"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fIwhoami\fR \- returns your resolver\'s local IP address, port and transport\.
|
\fIwhoami\fR \- returns your resolver\'s local IP address, port and transport\.
|
||||||
|
|
Loading…
Add table
Reference in a new issue