TrueCloudLab/coredns
16
0
Fork 2
Code Issues Pull requests 4 Projects Releases Packages Wiki Activity Actions

doc: run make -f Makefile.doc (#3314)

Browse source 
add the acl manual page; mechanical change otherwise.

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben 2019-09-27 13:30:22 +01:00 • committed by GitHub
parent 7328d3e8c9
commit 4568a3c25a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
39 changed files with 259 additions and 136 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

105
man/coredns-acl.7 Normal file
View file

@ -0,0 +1,105 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ACL" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.PP
\fIacl\fP - enforces access control policies on source ip and prevents unauthorized access to DNS servers.
.SH "DESCRIPTION"
.PP
With \fB\fCacl\fR enabled, users are able to block suspicous DNS queries by configuring IP filter rule sets, i.e. allowing authorized queries to recurse or blocking unauthorized queries.
.PP
This plugin can be used multiple times per Server Block.
.SH "SYNTAX"
.PP
.RS
.nf
acl [ZONES...] {
ACTION [type QTYPE...] [net SOURCE...]
}
.fi
.RE
.IP \(bu 4
\fBZONES\fP zones it should be authoritative for. If empty, the zones from the configuration block are used.
.IP \(bu 4
\fBACTION\fP (\fIallow\fP or \fIblock\fP) defines the way to deal with DNS queries matched by this rule. The default action is \fIallow\fP, which means a DNS query not matched by any rules will be allowed to recurse.
.IP \(bu 4
\fBQTYPE\fP is the query type to match for the requests to be allowed or blocked. Common resource record types are supported. \fB\fC*\fR stands for all record types. The default behavior for an omitted \fB\fCtype QTYPE...\fR is to match all kinds of DNS queries (same as \fB\fCtype *\fR).
.IP \(bu 4
\fBSOURCE\fP is the source IP address to match for the requests to be allowed or blocked. Typical CIDR notation and single IP address are supported. \fB\fC*\fR stands for all possible source IP addresses.
.SH "EXAMPLES"
.PP
To demonstrate the usage of plugin acl, here we provide some typical examples.
.PP
Block all DNS queries with record type A from 192.168.0.0/16：
.PP
.RS
.nf
\&. {
acl {
block type A net 192.168.0.0/16
}
}
.fi
.RE
.PP
Block all DNS queries from 192.168.0.0/16 except for 192.168.1.0/24:
.PP
.RS
.nf
\&. {
acl {
allow net 192.168.1.0/24
block net 192.168.0.0/16
}
}
.fi
.RE
.PP
Allow only DNS queries from 192.168.0.0/24 and 192.168.1.0/24:
.PP
.RS
.nf
\&. {
acl {
allow net 192.168.0.0/16 192.168.1.0/24
block
}
}
.fi
.RE
.PP
Block all DNS queries from 192.168.1.0/24 towards a.example.org:
.PP
.RS
.nf
example.org {
acl a.example.org {
block net 192.168.1.0/24
}
}
.fi
.RE

6
man/coredns-any.7
View file

@ -1,9 +1,9 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ANY" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-ANY" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIany\fP - give a minimal response to ANY queries. \fIany\fP - gives a minimal response to ANY queries.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -41,7 +41,7 @@ A \fB\fCdig +nocmd ANY example.org +noall +answer\fR now returns:
.RS .RS
.nf .nf
example.org. 8482 IN HINFO "ANY obsoleted" "See RFC 8482" example.org. 8482 IN HINFO "ANY obsoleted" "See RFC 8482"
.fi .fi
.RE .RE

6
man/coredns-auto.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-AUTO" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-AUTO" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -77,8 +77,8 @@ notifies to 10.240.1.1
.RS .RS
.nf .nf
\&. { org {
auto org { auto {
directory /etc/coredns/zones/org directory /etc/coredns/zones/org
transfer to * transfer to *
transfer to 10.240.1.1 transfer to 10.240.1.1

2
man/coredns-autopath.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-AUTOPATH" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-AUTOPATH" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

4
man/coredns-azure.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-AZURE" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-AZURE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

14
man/coredns-cache.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CACHE" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-CACHE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -133,18 +133,18 @@ Proxy to Google Public DNS and only cache responses for example.org (or below).
.RE .RE
.PP .PP
Enable caching for all zones, keep a positive cache size of 5000 and a negative cache size of 2500: Enable caching for \fB\fCexample.org\fR, keep a positive cache size of 5000 and a negative cache size of 2500:
.PP .PP
.RS .RS
.nf .nf
. { example.org {
cache { cache {
success 5000 success 5000
denial 2500 denial 2500
} }
} }
.fi .fi
.RE .RE

10
man/coredns-cancel.7
View file

@ -1,9 +1,9 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CANCEL" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-CANCEL" 7 "September 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 - cancels a request's context after 5001 milliseconds.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -11,7 +11,7 @@ The \fIcancel\fP plugin creates a canceling context for each request. It adds a
triggered after 5001 milliseconds. triggered after 5001 milliseconds.
.PP .PP
The 5001 number is chosen because the default timeout for DNS clients is 5 seconds, after that they The 5001 number was chosen because the default timeout for DNS clients is 5 seconds, after that they
give up. give up.
.PP .PP
@ -37,7 +37,7 @@ cancel [TIMEOUT]
.RS .RS
.nf .nf
\&. { example.org {
cancel cancel
whoami whoami
} }
@ -52,7 +52,7 @@ Or with a custom timeout:
.RS .RS
.nf .nf
\&. { example.org {
cancel 1s cancel 1s
whoami whoami
} }

4
man/coredns-chaos.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CHAOS" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-CHAOS" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -70,7 +70,7 @@ And test with \fB\fCdig\fR:
% dig @localhost CH TXT version.bind % dig @localhost CH TXT version.bind
\&... \&...
;; ANSWER SECTION: ;; ANSWER SECTION:
version.bind. 0 CH TXT "CoreDNS\-001" version.bind. 0 CH TXT "CoreDNS\-001"
\&... \&...
.fi .fi

6
man/coredns-clouddns.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CLOUDDNS" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-CLOUDDNS" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -60,7 +60,7 @@ Enable clouddns with implicit GCP credentials and resolve CNAMEs via 10.0.0.1:
.RS .RS
.nf .nf
\&. { example.org {
clouddns example.org.:gcp\-example\-project:example\-zone clouddns example.org.:gcp\-example\-project:example\-zone
forward . 10.0.0.1 forward . 10.0.0.1
} }
@ -75,7 +75,7 @@ Enable clouddns with fallthrough:
.RS .RS
.nf .nf
\&. { example.org {
clouddns example.org.:gcp\-example\-project:example\-zone clouddns example.com.:gcp\-example\-project:example\-zone\-2 { clouddns example.org.:gcp\-example\-project:example\-zone clouddns example.com.:gcp\-example\-project:example\-zone\-2 {
fallthrough example.gov. fallthrough example.gov.
} }

2
man/coredns-debug.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DEBUG" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-DEBUG" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

6
man/coredns-dnssec.7
View file

@ -1,13 +1,13 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DNSSEC" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-DNSSEC" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIdnssec\fP - enable on-the-fly DNSSEC signing of served data. \fIdnssec\fP - enables 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
this leads to smaller signatures (compared to RSA). NSEC3 is \fInot\fP supported. this leads to smaller signatures (compared to RSA). NSEC3 is \fInot\fP supported.

6
man/coredns-dnstap.7
View file

@ -1,13 +1,13 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DNSTAP" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-DNSTAP" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIdnstap\fP - enable logging to dnstap. \fIdnstap\fP - enables 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; see http://dnstap.info
\[la]http://dnstap.info\[ra]. With this \[la]http://dnstap.info\[ra]. With this
plugin you make CoreDNS output dnstap logging. plugin you make CoreDNS output dnstap logging.

15
man/coredns-erratic.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ERRATIC" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-ERRATIC" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -55,7 +55,7 @@ This plugin reports readiness to the ready plugin.
.RS .RS
.nf .nf
\&. { example.org {
erratic { erratic {
drop 3 drop 3
} }
@ -71,7 +71,7 @@ Or even shorter if the defaults suits you. Note this only drops queries, it does
.RS .RS
.nf .nf
\&. { example.org {
erratic erratic
} }
@ -85,7 +85,7 @@ Delay 1 in 3 queries for 50ms
.RS .RS
.nf .nf
\&. { example.org {
erratic { erratic {
delay 3 50ms delay 3 50ms
} }
@ -101,7 +101,7 @@ Delay 1 in 3 and truncate 1 in 5.
.RS .RS
.nf .nf
\&. { example.org {
erratic { erratic {
delay 3 5ms delay 3 5ms
truncate 5 truncate 5
@ -118,7 +118,7 @@ Drop every second query.
.RS .RS
.nf .nf
\&. { example.org {
erratic { erratic {
drop 2 drop 2
truncate 2 truncate 2
@ -131,7 +131,6 @@ Drop every second query.
.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 RFC 5737
RFC 5737
\[la]https://tools.ietf.org/html/rfc5737\[ra]. \[la]https://tools.ietf.org/html/rfc5737\[ra].

10
man/coredns-errors.7
View file

@ -1,9 +1,9 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ERRORS" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-ERRORS" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIerrors\fP - enable error logging. \fIerrors\fP - enables error logging.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -33,7 +33,7 @@ Extra knobs are available with an expanded syntax:
.nf .nf
errors { errors {
consolidate DURATION REGEXP consolidate DURATION REGEXP
} }
.fi .fi
@ -59,13 +59,13 @@ For better performance, it's recommended to use the \fB\fC^\fR or \fB\fC$\fR met
.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 in the example.org domain and Log errors to standard output.
.PP .PP
.RS .RS
.nf .nf
\&. { example.org {
whoami whoami
errors errors
} }

26
man/coredns-etcd.7
View file

@ -1,9 +1,9 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ETCD" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-ETCD" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIetcd\fP - enable SkyDNS service discovery from etcd. \fIetcd\fP - enables SkyDNS service discovery from etcd.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -12,7 +12,7 @@ a generic DNS zone data plugin. Only a subset of DNS record types are implemente
and delegations are not handled at all. and delegations are not handled at all.
.PP .PP
The data in etcd instance has to be encoded as The data in the etcd instance has to be encoded as
a message a message
\[la]https://github.com/skynetservices/skydns/blob/2fcff74cdc9f9a7dd64189a447ef27ac354b725f/msg/service.go#L26\[ra] \[la]https://github.com/skynetservices/skydns/blob/2fcff74cdc9f9a7dd64189a447ef27ac354b725f/msg/service.go#L26\[ra]
like SkyDNS like SkyDNS
@ -116,15 +116,19 @@ This is the default SkyDNS setup, with everything specified in full:
.RS .RS
.nf .nf
\&. { skydns.local {
etcd skydns.local { etcd {
path /skydns path /skydns
endpoint http://localhost:2379 endpoint http://localhost:2379
} }
prometheus prometheus
cache 160 skydns.local cache
loadbalance loadbalance
}
\&. {
forward . 8.8.8.8:53 8.8.4.4:53 forward . 8.8.8.8:53 8.8.4.4:53
cache
} }
.fi .fi
@ -138,12 +142,16 @@ when resolving external pointing CNAMEs.
.RS .RS
.nf .nf
\&. { skydns.local {
etcd skydns.local { etcd {
path /skydns path /skydns
} }
cache 160 skydns.local cache
}
\&. {
forward . /etc/resolv.conf forward . /etc/resolv.conf
cache
} }
.fi .fi

2
man/coredns-file.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-FILE" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-FILE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

7
man/coredns-forward.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-FORWARD" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-FORWARD" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -160,9 +160,8 @@ and we are randomly (this always uses the \fB\fCrandom\fR policy) spraying to an
.PP .PP
Where \fB\fCto\fR is one of the upstream servers (\fBTO\fP from the config), \fB\fCproto\fR is the protocol used by Where \fB\fCto\fR is one of the upstream servers (\fBTO\fP from the config), \fB\fCrcode\fR is the returned RCODE
the incoming query ("tcp" or "udp"), and family the transport family ("1" for IPv4, and "2" for from the upstream.
IPv6).
.SH "EXAMPLES" .SH "EXAMPLES"
.PP .PP

2
man/coredns-grpc.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-GRPC" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-GRPC" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

2
man/coredns-health.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-HEALTH" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-HEALTH" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

17
man/coredns-hosts.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-HOSTS" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-HOSTS" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -93,6 +93,16 @@ 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 "METRICS"
.PP
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported:
.IP \(bu 4
\fB\fCcoredns_hosts_entries_count{}\fR - The combined number of entries in hosts and Corefile.
.IP \(bu 4
\fB\fCcoredns_hosts_reload_timestamp_seconds{}\fR - The timestamp of the last reload of hosts file.
.SH "EXAMPLES" .SH "EXAMPLES"
.PP .PP
Load \fB\fC/etc/hosts\fR file. Load \fB\fC/etc/hosts\fR file.
@ -146,11 +156,12 @@ Load hosts file inlined in Corefile.
.RS .RS
.nf .nf
\&. { example.hosts example.org {
hosts example.hosts example.org { hosts {
10.0.0.1 example.org 10.0.0.1 example.org
fallthrough fallthrough
} }
whoami
} }
.fi .fi

8
man/coredns-import.7
View file

@ -1,13 +1,13 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-IMPORT" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-IMPORT" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIimport\fP - include files or reference snippets from a Corefile. \fIimport\fP - includes files or references 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 is to
reference predefined snippets. Both can help to avoid some duplication. reference predefined snippets. Both can help to avoid some duplication.
.PP .PP
@ -45,7 +45,7 @@ label surrounded by parentheses:
.nf .nf
(mysnippet) { (mysnippet) {
... ...
} }
.fi .fi

20
man/coredns-k8s_external.7
View file

@ -1,9 +1,9 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-K8S_EXTERNAL" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-K8S_EXTERNAL" 7 "September 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 - resolves load balancer and external IPs from outside Kubernetes clusters.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -22,14 +22,14 @@ By default the apex of the zone will look like the following (assuming the zone
.RS .RS
.nf .nf
example.org. 5 IN SOA ns1.dns.example.org. hostmaster.example.org. ( example.org. 5 IN SOA ns1.dns.example.org. hostmaster.example.org. (
12345 ; serial 12345 ; serial
14400 ; refresh (4 hours) 14400 ; refresh (4 hours)
3600 ; retry (1 hour) 3600 ; retry (1 hour)
604800 ; expire (1 week) 604800 ; expire (1 week)
5 ; minimum (4 hours) 5 ; minimum (4 hours)
) )
example.org 5 IN NS ns1.dns.example.org. example.org 5 IN NS ns1.dns.example.org.
ns1.dns.example.org. 5 IN A .... ns1.dns.example.org. 5 IN A ....
ns1.dns.example.org. 5 IN AAAA .... ns1.dns.example.org. 5 IN AAAA ....

10
man/coredns-kubernetes.7
View file

@ -1,9 +1,9 @@
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-KUBERNETES" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-KUBERNETES" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIkubernetes\fP - enables the reading zone data from a Kubernetes cluster. \fIkubernetes\fP - enables reading zone data from a Kubernetes cluster.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -302,8 +302,8 @@ For example, wildcards can be used to resolve all Endpoints for a Service as \fB
.RS .RS
.nf .nf
*.service.default.svc.cluster.local. 5 IN A 192.168.10.10 *.service.default.svc.cluster.local. 5 IN A 192.168.10.10
*.service.default.svc.cluster.local. 5 IN A 192.168.25.15 *.service.default.svc.cluster.local. 5 IN A 192.168.25.15
.fi .fi
.RE .RE

10
man/coredns-loadbalance.7
View file

@ -1,18 +1,18 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-LOADBALANCE" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-LOADBALANCE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIloadbalance\fP - randomize the order of A, AAAA and MX records. \fIloadbalance\fP - randomizes 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 load balancer by randomizing the order of A, AAAA,
and MX records in the answer. and MX records in the answer.
.PP .PP
See Wikipedia See Wikipedia
\[la]https://en.wikipedia.org/wiki/Round-robin_DNS\[ra] about the pros and cons on this \[la]https://en.wikipedia.org/wiki/Round-robin_DNS\[ra] about the pros and cons of this
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.
@ -27,7 +27,7 @@ loadbalance [POLICY]
.RE .RE
.IP \(bu 4 .IP \(bu 4
\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"

4
man/coredns-log.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-LOG" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-LOG" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -155,7 +155,7 @@ Each of these logs will be outputted with \fB\fClog.Infof\fR, so a typical examp
.RS .RS
.nf .nf
2018\-10\-30T19:10:07.547Z [INFO] [::1]:50759 \- 29008 "A IN example.org. udp 41 false 4096" NOERROR qr,rd,ra,ad 68 0.037990251s [INFO] [::1]:50759 \- 29008 "A IN example.org. udp 41 false 4096" NOERROR qr,rd,ra,ad 68 0.037990251s
~~~~ ~~~~
## Examples ## Examples

4
man/coredns-loop.7
View file

@ -1,9 +1,9 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-LOOP" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-LOOP" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIloop\fP - detect simple forwarding loops and halt the server. \fIloop\fP - detects simple forwarding loops and halts the server.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP

14
man/coredns-metadata.7
View file

@ -1,31 +1,31 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-METADATA" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-METADATA" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fImetadata\fP - enable a meta data collector. \fImetadata\fP - enables a metadata 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
\[la]https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider\[ra] will be called for \[la]https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider\[ra] will be called for
each DNS query, at beginning of the process for that query, in order to add its own meta data to each DNS query, at the beginning of the process for that query, in order to add its own metadata to
context. context.
.PP .PP
The meta data collected will be available for all plugins, via the Context parameter provided in the The metadata collected will be available for all plugins, via the Context parameter provided in the
ServeDNS function. The package (code) documentation has examples on how to inspect and retrieve ServeDNS function. The package (code) documentation has examples on how to inspect and retrieve
metadata a plugin might be interested in. metadata a plugin might be interested in.
.PP .PP
The meta data is added by setting a label with a value in the context. These labels should be named The metadata is added by setting a label with a value in the context. These labels should be named
\fB\fCplugin/NAME\fR, where \fBNAME\fP is something descriptive. The only hard requirement the \fImetadata\fP \fB\fCplugin/NAME\fR, where \fBNAME\fP is something descriptive. The only hard requirement the \fImetadata\fP
plugin enforces is that the labels contains a slash. See the documentation for plugin enforces is that the labels contain a slash. See the documentation for
\fB\fCmetadata.SetValueFunc\fR. \fB\fCmetadata.SetValueFunc\fR.
.PP .PP
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 metadata". 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"

2
man/coredns-metrics.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-METRICS" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-METRICS" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

6
man/coredns-nsid.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-NSID" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-NSID" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -39,7 +39,7 @@ Enable nsid:
.RS .RS
.nf .nf
\&. { example.org {
whoami whoami
nsid Use The Force nsid Use The Force
} }
@ -66,7 +66,7 @@ And now a client with NSID support will see an OPT record with the NSID option:
; EDNS: version: 0, flags:; udp: 4096 ; EDNS: version: 0, flags:; udp: 4096
; NSID: 55 73 65 20 54 68 65 20 46 6f 72 63 65 ("Use The Force") ; NSID: 55 73 65 20 54 68 65 20 46 6f 72 63 65 ("Use The Force")
;; QUESTION SECTION: ;; QUESTION SECTION:
;whoami.example.org. IN A ;whoami.example.org. IN A
.fi .fi
.RE .RE

2
man/coredns-pprof.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-PPROF" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-PPROF" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

2
man/coredns-ready.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-READY" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-READY" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

22
man/coredns-reload.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-RELOAD" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-RELOAD" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -48,17 +48,15 @@ reload [INTERVAL] [JITTER]
.fi .fi
.RE .RE
.IP \(bu 4 .PP
The plugin will check for changes every \fBINTERVAL\fP, subject to +/- the \fBJITTER\fP duration The plugin will check for changes every \fBINTERVAL\fP, subject to +/- the \fBJITTER\fP duration.
.IP \(bu 4 .IP \(bu 4
\fBINTERVAL\fP and \fBJITTER\fP are Golang (durations)[https://golang.org/pkg/time/#ParseDuration \fBINTERVAL\fP and \fBJITTER\fP are Golang (durations)[https://golang.org/pkg/time/#ParseDuration
\[la]https://golang.org/pkg/time/#ParseDuration\[ra]] \[la]https://golang.org/pkg/time/#ParseDuration\[ra]].
.IP \(bu 4 The default \fBINTERVAL\fP is 30s, default \fBJITTER\fP is 15s, the minimal value for \fBINTERVAL\fP
Default \fBINTERVAL\fP is 30s, default \fBJITTER\fP is 15s is 2s, and for \fBJITTER\fP it is 1s. If \fBJITTER\fP is more than half of \fBINTERVAL\fP, it will be
.IP \(bu 4 set to half of \fBINTERVAL\fP
Minimal value for \fBINTERVAL\fP is 2s, and for \fBJITTER\fP is 1s
.IP \(bu 4
If \fBJITTER\fP is more than half of \fBINTERVAL\fP, it will be set to half of \fBINTERVAL\fP
.SH "EXAMPLES" .SH "EXAMPLES"
@ -102,8 +100,8 @@ where the reload fails, and you loose functionality. Consider the following Core
.nf .nf
\&. { \&. {
health :8080 health :8080
whoami whoami
} }
.fi .fi

2
man/coredns-rewrite.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-REWRITE" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-REWRITE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

15
man/coredns-route53.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ROUTE53" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-ROUTE53" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -73,8 +73,11 @@ Enable route53 with implicit AWS credentials and resolve CNAMEs via 10.0.0.1:
.RS .RS
.nf .nf
example.org {
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7
}
\&. { \&. {
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7
forward . 10.0.0.1 forward . 10.0.0.1
} }
@ -88,7 +91,7 @@ Enable route53 with explicit AWS credentials:
.RS .RS
.nf .nf
\&. { example.org {
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 { route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 {
aws\_access\_key AWS\_ACCESS\_KEY\_ID AWS\_SECRET\_ACCESS\_KEY aws\_access\_key AWS\_ACCESS\_KEY\_ID AWS\_SECRET\_ACCESS\_KEY
} }
@ -120,7 +123,7 @@ Enable route53 with multiple hosted zones with the same domain:
.RS .RS
.nf .nf
\&. { example.org {
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 example.org.:Z93A52145678156 route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 example.org.:Z93A52145678156
} }
@ -134,7 +137,7 @@ Enable route53 and refresh records every 3 minutes
.RS .RS
.nf .nf
\&. { example.org {
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 { route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 {
refresh 3m refresh 3m
} }

2
man/coredns-secondary.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-SECONDARY" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-SECONDARY" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

4
man/coredns-sign.7
View file

@ -1,9 +1,9 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-SIGN" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-SIGN" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
\fIsign\fP - add DNSSEC records to zone files. \fIsign\fP - adds DNSSEC records to zone files.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP

2
man/coredns-template.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TEMPLATE" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-TEMPLATE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP

10
man/coredns-tls.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TLS" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-TLS" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -60,8 +60,8 @@ nameservers defined in \fB\fC/etc/resolv.conf\fR to resolve the query. This prox
.nf .nf
tls://.:5553 { tls://.:5553 {
tls cert.pem key.pem ca.pem tls cert.pem key.pem ca.pem
forward . /etc/resolv.conf forward . /etc/resolv.conf
} }
.fi .fi
@ -76,8 +76,8 @@ incoming queries.
.nf .nf
grpc://. { grpc://. {
tls cert.pem key.pem ca.pem tls cert.pem key.pem ca.pem
forward . /etc/resolv.conf forward . /etc/resolv.conf
} }
.fi .fi

4
man/coredns-whoami.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl .\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-WHOAMI" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" .TH "COREDNS-WHOAMI" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME" .SH "NAME"
.PP .PP
@ -50,7 +50,7 @@ Start a server on the default port and load the \fIwhoami\fP plugin.
.RS .RS
.nf .nf
\&. { example.org {
whoami whoami
} }