Regen man-pages (#2631)

Mechanical change: make -f Makefile.doc

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2019-02-27 20:32:48 +00:00
committed by Yong Tang
parent 42cf6606fc
commit 7ffa4f19bb
18 changed files with 110 additions and 84 deletions

View 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\-AUTO" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-AUTO" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
. .
.SH "NAME" .SH "NAME"
\fIauto\fR \- enables serving zone data from an RFC 1035\-style master file, which is automatically picked up from disk\. \fIauto\fR \- enables serving zone data from an RFC 1035\-style master file, which is automatically picked up from disk\.
@@ -17,7 +17,7 @@ auto [ZONES\.\.\.] {
directory DIR [REGEXP ORIGIN_TEMPLATE [TIMEOUT]] directory DIR [REGEXP ORIGIN_TEMPLATE [TIMEOUT]]
reload DURATION reload DURATION
no_reload no_reload
upstream [ADDRESS\.\.\.] upstream
} }
. .
.fi .fi
@@ -26,16 +26,16 @@ auto [ZONES\.\.\.] {
\fBZONES\fR zones it should be authoritative for\. If empty, the zones from the configuration block are used\. \fBZONES\fR zones it should be authoritative for\. If empty, the zones from the configuration block are used\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBdirectory\fR loads zones from the specified \fBDIR\fR\. If a file name matches \fBREGEXP\fR it will be used to extract the origin\. \fBORIGIN_TEMPLATE\fR will be used as a template for the origin\. Strings like \fB{<number>}\fR are replaced with the respective matches in the file name, e\.g\. \fB{1}\fR is the first match, \fB{2}\fR is the second\. The default is: \fBdb\e\.(\.*) {1}\fR i\.e\. from a file with the name \fBdb\.example\.com\fR, the extracted origin will be \fBexample\.com\fR\. \fBTIMEOUT\fR specifies how often CoreDNS should scan the directory; the default is every 60 seconds\. This value is in seconds\. The minimum value is 1 second\. \fBdirectory\fR loads zones from the specified \fBDIR\fR\. If a file name matches \fBREGEXP\fR it will be used to extract the origin\. \fBORIGIN_TEMPLATE\fR will be used as a template for the origin\. Strings like \fB{<number>}\fR are replaced with the respective matches in the file name, e\.g\. \fB{1}\fR is the first match, \fB{2}\fR is the second\. The default is: \fBdb\e\.(\.*) {1}\fR i\.e\. from a file with the name \fBdb\.example\.com\fR, the extracted origin will be \fBexample\.com\fR\. \fBTIMEOUT\fR is deprecated and will be removed in a subsequent version\. \fBreload\fR will be used, if not defined (it specifies how often CoreDNS should scan the directory to watch for file removal and addition; the default is every 60 seconds\. This value is in seconds\. The minimum value is 1 second\.)
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBreload\fR interval to perform reload of zone if SOA version changes\. Default is one minute\. Value of \fB0\fR means to not scan for changes and reload\. eg\. \fB30s\fR checks zonefile every 30 seconds and reloads zone when serial changes\. \fBreload\fR interval to perform reloads of zones if SOA version changes and zonefiles\. Default is one minute\. Value of \fB0\fR means to not scan for changes and reload\. eg\. \fB30s\fR checks zonefile every 30 seconds and reloads zone when serial changes\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBno_reload\fR deprecated\. Sets reload to 0\. \fBno_reload\fR deprecated\. Sets reload to 0\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBupstream\fR defines upstream resolvers to be used resolve external names found (think CNAMEs) pointing to external names\. \fBADDRESS\fR can be an IP address, an IP:port or a string pointing to a file that is structured as /etc/resolv\.conf\. If no \fBADDRESS\fR is given, CoreDNS will resolve CNAMEs against itself\. \fBupstream\fR defines upstream resolvers to be used resolve external names found (think CNAMEs) pointing to external names\. CoreDNS will resolve CNAMEs against itself\.
. .
.IP "" 0 .IP "" 0
. .

View 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\-CACHE" "7" "December 2018" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-CACHE" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
. .
.SH "NAME" .SH "NAME"
\fIcache\fR \- enables a frontend cache\. \fIcache\fR \- enables a frontend cache\.
@@ -21,7 +21,7 @@ cache [TTL] [ZONES\.\.\.]
.fi .fi
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBTTL\fR max TTL in seconds\. If not specified, the maximum TTL will be used, which is 3600 for noerror responses and 1800 for denial of existence ones\. Setting a TTL of 300: \fBcache 300\fR would cache records up to 300 seconds\. \fBTTL\fR max TTL in seconds\. If not specified, the maximum TTL will be used, which is 3600 for NOERROR responses and 1800 for denial of existence ones\. Setting a TTL of 300: \fBcache 300\fR would cache records up to 300 seconds\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBZONES\fR zones it should cache for\. If empty, the zones from the configuration block are used\. \fBZONES\fR zones it should cache for\. If empty, the zones from the configuration block are used\.

View 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\-ERRATIC" "7" "October 2018" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-ERRATIC" "7" "February 2019" "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\.

View 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\-ETCD" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-ETCD" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
. .
.SH "NAME" .SH "NAME"
\fIetcd\fR \- enables reading zone data from an etcd version 3 instance\. \fIetcd\fR \- enables reading zone data from an etcd version 3 instance\.
@@ -36,10 +36,10 @@ If you want to \fBround robin\fR A and AAAA responses look at the \fBloadbalance
.nf .nf
etcd [ZONES\.\.\.] { etcd [ZONES\.\.\.] {
stubzones
fallthrough [ZONES\.\.\.] fallthrough [ZONES\.\.\.]
path PATH path PATH
endpoint ENDPOINT\.\.\. endpoint ENDPOINT\.\.\.
credentials USERNAME PASSWORD
upstream [ADDRESS\.\.\.] upstream [ADDRESS\.\.\.]
tls CERT KEY CACERT tls CERT KEY CACERT
} }
@@ -49,9 +49,6 @@ etcd [ZONES\.\.\.] {
.IP "" 0 .IP "" 0
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBstubzones\fR enables the stub zones feature\. The stubzone is \fIonly\fR done in the etcd tree located under the \fIfirst\fR zone specified\.
.
.IP "\(bu" 4
\fBfallthrough\fR If zone matches but no record can be generated, pass request to the next plugin\. If \fB[ZONES\.\.\.]\fR is omitted, then fallthrough happens for all zones for which the plugin is authoritative\. If specific zones are listed (for example \fBin\-addr\.arpa\fR and \fBip6\.arpa\fR), then only queries for those zones will be subject to fallthrough\. \fBfallthrough\fR If zone matches but no record can be generated, pass request to the next plugin\. If \fB[ZONES\.\.\.]\fR is omitted, then fallthrough happens for all zones for which the plugin is authoritative\. If specific zones are listed (for example \fBin\-addr\.arpa\fR and \fBip6\.arpa\fR), then only queries for those zones will be subject to fallthrough\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
@@ -61,6 +58,9 @@ etcd [ZONES\.\.\.] {
\fBENDPOINT\fR the etcd endpoints\. Defaults to "http://localhost:2379"\. \fBENDPOINT\fR the etcd endpoints\. Defaults to "http://localhost:2379"\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBcredentials\fR is used to set the \fBUSERNAME\fR and \fBPASSWORD\fR for accessing the etcd cluster\.
.
.IP "\(bu" 4
\fBupstream\fR upstream resolvers to be used resolve external names found in etcd (think CNAMEs) pointing to external names\. If you want CoreDNS to act as a proxy for clients, you\'ll need to add the proxy plugin\. If no \fBADDRESS\fR is given, CoreDNS will resolve CNAMEs against itself\. \fBADDRESS\fR can be an IP address, and IP:port or a string pointing to a file that is structured as /etc/resolv\.conf\. \fBupstream\fR upstream resolvers to be used resolve external names found in etcd (think CNAMEs) pointing to external names\. If you want CoreDNS to act as a proxy for clients, you\'ll need to add the proxy plugin\. If no \fBADDRESS\fR is given, CoreDNS will resolve CNAMEs against itself\. \fBADDRESS\fR can be an IP address, and IP:port or a string pointing to a file that is structured as /etc/resolv\.conf\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
@@ -87,7 +87,7 @@ three arguments \- path to cert PEM file, path to client private key PEM file, p
CoreDNS etcd plugin leverages directory structure to look for related entries\. For example an entry \fB/skydns/test/skydns/mx\fR would have entries like \fB/skydns/test/skydns/mx/a\fR, \fB/skydns/test/skydns/mx/b\fR and so on\. Similarly a directory \fB/skydns/test/skydns/mx1\fR will have all \fBmx1\fR entries\. CoreDNS etcd plugin leverages directory structure to look for related entries\. For example an entry \fB/skydns/test/skydns/mx\fR would have entries like \fB/skydns/test/skydns/mx/a\fR, \fB/skydns/test/skydns/mx/b\fR and so on\. Similarly a directory \fB/skydns/test/skydns/mx1\fR will have all \fBmx1\fR entries\.
. .
.P .P
With etcd3, support for hierarchial keys are dropped \fIhttps://coreos\.com/etcd/docs/latest/learning/api\.html\fR\. This means there are no directories but only flat keys with prefixes in etcd3\. To accommodate lookups, etcdv3 plugin now does a lookup on prefix \fB/skydns/test/skydns/mx/\fR to search for entries like \fB/skydns/test/skydns/mx/a\fR etc, and if there is nothing found on \fB/skydns/test/skydns/mx/\fR, it looks for \fB/skydns/test/skydns/mx\fR to find entries like \fB/skydns/test/skydns/mx1\fR\. With etcd3, support for hierarchical keys are dropped \fIhttps://coreos\.com/etcd/docs/latest/learning/api\.html\fR\. This means there are no directories but only flat keys with prefixes in etcd3\. To accommodate lookups, etcdv3 plugin now does a lookup on prefix \fB/skydns/test/skydns/mx/\fR to search for entries like \fB/skydns/test/skydns/mx/a\fR etc, and if there is nothing found on \fB/skydns/test/skydns/mx/\fR, it looks for \fB/skydns/test/skydns/mx\fR to find entries like \fB/skydns/test/skydns/mx1\fR\.
. .
.P .P
This causes two lookups from CoreDNS to etcdv3 in certain cases\. This causes two lookups from CoreDNS to etcdv3 in certain cases\.
@@ -107,10 +107,9 @@ This is the default SkyDNS setup, with everything specified in full:
\&\. { \&\. {
etcd skydns\.local { etcd skydns\.local {
stubzones
path /skydns path /skydns
endpoint http://localhost:2379 endpoint http://localhost:2379
upstream 8\.8\.8\.8:53 8\.8\.4\.4:53 upstream
} }
prometheus prometheus
cache 160 skydns\.local cache 160 skydns\.local
@@ -132,7 +131,7 @@ Or a setup where we use \fB/etc/resolv\.conf\fR as the basis for the proxy and t
\&\. { \&\. {
etcd skydns\.local { etcd skydns\.local {
path /skydns path /skydns
upstream /etc/resolv\.conf upstream
} }
cache 160 skydns\.local cache 160 skydns\.local
proxy \. /etc/resolv\.conf proxy \. /etc/resolv\.conf
@@ -161,7 +160,7 @@ etcd skydns\.local {
Before getting started with these examples, please setup \fBetcdctl\fR (with \fBetcdv3\fR API) as explained here \fIhttps://coreos\.com/etcd/docs/latest/dev\-guide/interacting_v3\.html\fR\. This will help you to put sample keys in your etcd server\. Before getting started with these examples, please setup \fBetcdctl\fR (with \fBetcdv3\fR API) as explained here \fIhttps://coreos\.com/etcd/docs/latest/dev\-guide/interacting_v3\.html\fR\. This will help you to put sample keys in your etcd server\.
. .
.P .P
If you prefer, you can use \fBcurl\fR to populate the \fBetcd\fR server, but with \fBcurl\fR the endpoint URL depends on the version of \fBetcd\fR\. For instance, \fBetcd v3\.2\fR or before uses only [CLIENT\-URL]/v3alpha/\fIwhile \fBetcd v3\.5\fR or later uses [CLIENT\-URL]/v3/\fR \. Also, Key and Value must be base64 encoded in the JSON payload\. With, \fBetcdctl\fR these details are automatically taken care off\. You can check this document \fIhttps://github\.com/coreos/etcd/blob/master/Documentation/dev\-guide/api_grpc_gateway\.md#notes\fR for details\. If you prefer, you can use \fBcurl\fR to populate the \fBetcd\fR server, but with \fBcurl\fR the endpoint URL depends on the version of \fBetcd\fR\. For instance, \fBetcd v3\.2\fR or before uses only [CLIENT\-URL]/v3alpha/\fIwhile \fBetcd v3\.5\fR or later uses [CLIENT\-URL]/v3/\fR \. Also, Key and Value must be base64 encoded in the JSON payload\. With \fBetcdctl\fR these details are automatically taken care off\. You can check this document \fIhttps://github\.com/coreos/etcd/blob/master/Documentation/dev\-guide/api_grpc_gateway\.md#notes\fR for details\.
. .
.SS "REVERSE ZONES" .SS "REVERSE ZONES"
Reverse zones are supported\. You need to make CoreDNS aware of the fact that you are also authoritative for the reverse\. For instance if you want to add the reverse for 10\.0\.0\.0/24, you\'ll need to add the zone \fB0\.0\.10\.in\-addr\.arpa\fR to the list of zones\. Showing a snippet of a Corefile: Reverse zones are supported\. You need to make CoreDNS aware of the fact that you are also authoritative for the reverse\. For instance if you want to add the reverse for 10\.0\.0\.0/24, you\'ll need to add the zone \fB0\.0\.10\.in\-addr\.arpa\fR to the list of zones\. Showing a snippet of a Corefile:
@@ -171,7 +170,6 @@ Reverse zones are supported\. You need to make CoreDNS aware of the fact that yo
.nf .nf
etcd skydns\.local 10\.0\.0\.0/24 { etcd skydns\.local 10\.0\.0\.0/24 {
stubzones
\.\.\. \.\.\.
. .
.fi .fi
@@ -206,7 +204,7 @@ reverse\.skydns\.local\.
.IP "" 0 .IP "" 0
. .
.SS "ZONE NAME AS A RECORD" .SS "ZONE NAME AS A RECORD"
The zone name itself can be used A record\. This behavior can be achieved by writing special entries to the ETCD path of your zone\. If your zone is named \fBskydns\.local\fR for example, you can create an \fBA\fR record for this zone as follows: The zone name itself can be used as A record\. This behavior can be achieved by writing special entries to the ETCD path of your zone\. If your zone is named \fBskydns\.local\fR for example, you can create an \fBA\fR record for this zone as follows:
. .
.IP "" 4 .IP "" 4
. .
@@ -233,7 +231,7 @@ If you query the zone name itself, you will receive the created \fBA\fR record:
.IP "" 0 .IP "" 0
. .
.P .P
If you would like to use DNS RR for the zone name, you can set the following: ~~~ % etcdctl put /skydns/local/skydns/x1 \'{"host":"1\.1\.1\.1","ttl":"60"}\' % etcdctl put /skydns/local/skydns/x2 \'{"host":"1\.1\.1\.2","ttl":"60"}\' ~~~ If you would like to use DNS RR for the zone name, you can set the following: ~~~ % etcdctl put /skydns/local/skydns/x1 \'{"host":"1\.1\.1\.1","ttl":60}\' % etcdctl put /skydns/local/skydns/x2 \'{"host":"1\.1\.1\.2","ttl":60}\' ~~~
. .
.P .P
If you query the zone name now, you will get the following response: If you query the zone name now, you will get the following response:
@@ -251,7 +249,7 @@ If you query the zone name now, you will get the following response:
.IP "" 0 .IP "" 0
. .
.SS "ZONE NAME AS AAAA RECORD" .SS "ZONE NAME AS AAAA RECORD"
If you would like to use \fBAAAA\fR records for the zone name too, you can set the following: ~~~ % etcdctl put /skydns/local/skydns/x3 \'{"host":"2003::8:1","ttl":"60"}\' % etcdctl put /skydns/local/skydns/x4 \'{"host":"2003::8:2","ttl":"60"}\' ~~~ If you would like to use \fBAAAA\fR records for the zone name too, you can set the following: ~~~ % etcdctl put /skydns/local/skydns/x3 \'{"host":"2003::8:1","ttl":60}\' % etcdctl put /skydns/local/skydns/x4 \'{"host":"2003::8:2","ttl":60}\' ~~~
. .
.P .P
If you query the zone name for \fBAAAA\fR now, you will get the following response: ~~~ sh % dig +short skydns\.local AAAA @localhost 2003::8:1 2003::8:2 ~~~ If you query the zone name for \fBAAAA\fR now, you will get the following response: ~~~ sh % dig +short skydns\.local AAAA @localhost 2003::8:1 2003::8:2 ~~~

View 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\-FEDERATION" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-FEDERATION" "7" "February 2019" "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\.
@@ -18,7 +18,7 @@ Enabling \fIfederation\fR without also having \fIkubernetes\fR is a noop\.
federation [ZONES\.\.\.] { federation [ZONES\.\.\.] {
NAME DOMAIN NAME DOMAIN
upstream [ADDRESS\.\.\.] upstream
} }
. .
.fi .fi
@@ -27,7 +27,7 @@ federation [ZONES\.\.\.] {
Each \fBNAME\fR and \fBDOMAIN\fR defines federation membership\. One entry for each\. A duplicate \fBNAME\fR will silently overwrite any previous value\. Each \fBNAME\fR and \fBDOMAIN\fR defines federation membership\. One entry for each\. A duplicate \fBNAME\fR will silently overwrite any previous value\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBupstream\fR [\fBADDRESS\fR\.\.\.] defines the upstream resolvers used for resolving the \fBCNAME\fR target produced by this plugin\. If no \fBADDRESS\fR is given, CoreDNS will resolve External Services against itself\. \fBADDRESS\fR can be an IP, an IP:port, or a path to a file structured like resolv\.conf\. \fBupstream\fR [\fBADDRESS\fR\.\.\.] resolve the \fBCNAME\fR target produced by this plugin\. CoreDNS will resolve External Services against itself\.
. .
.IP "" 0 .IP "" 0
. .

View 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\-FILE" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-FILE" "7" "February 2019" "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\.
@@ -36,7 +36,7 @@ file DBFILE [ZONES\.\.\. ] {
transfer to ADDRESS\.\.\. transfer to ADDRESS\.\.\.
reload DURATION reload DURATION
no_reload no_reload
upstream [ADDRESS\.\.\.] upstream
} }
. .
.fi .fi
@@ -53,7 +53,7 @@ file DBFILE [ZONES\.\.\. ] {
\fBno_reload\fR deprecated\. Sets reload to 0\. \fBno_reload\fR deprecated\. Sets reload to 0\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBupstream\fR defines upstream resolvers to be used resolve external names found (think CNAMEs) pointing to external names\. This is only really useful when CoreDNS is configured as a proxy; for normal authoritative serving you don\'t need \fIor\fR want to use this\. \fBADDRESS\fR can be an IP address, an IP:port or a string pointing to a file that is structured as /etc/resolv\.conf\. If no \fBADDRESS\fR is given, CoreDNS will resolve CNAMEs against itself\. \fBupstream\fR resolve external names found (think CNAMEs) pointing to external names\. This is only really useful when CoreDNS is configured as a proxy; for normal authoritative serving you don\'t need \fIor\fR want to use this\. CoreDNS will resolve CNAMEs against itself\.
. .
.IP "" 0 .IP "" 0
. .

View 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" "December 2018" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-FORWARD" "7" "February 2019" "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\.
@@ -247,7 +247,7 @@ Or with multiple upstreams from the same provider
\&\. { \&\. {
forward \. tls://1\.1\.1\.1 tls://1\.0\.0\.1 { forward \. tls://1\.1\.1\.1 tls://1\.0\.0\.1 {
tls_servername loudflare\-dns\.com tls_servername cloudflare\-dns\.com
health_check 5s health_check 5s
} }
cache 30 cache 30

View 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\-HEALTH" "7" "December 2018" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-HEALTH" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
. .
.SH "NAME" .SH "NAME"
\fIhealth\fR \- enables a health check endpoint\. \fIhealth\fR \- enables a health check endpoint\.

View 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\-HOSTS" "7" "October 2018" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-HOSTS" "7" "February 2019" "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\.
@@ -10,6 +10,9 @@
The hosts plugin is useful for serving zones from a \fB/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 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 \fB/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 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 .P
The plugin reloads the content of the hosts file every 5 seconds\. Upon reload, CoreDNS will use the new definitions\. Should the file be deleted, any inlined content will continue to be served\. When the file is restored, it will then again be used\.
.
.P
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"
@@ -43,6 +46,9 @@ PTR records for reverse lookups are generated automatically by CoreDNS (based on
hosts [FILE [ZONES\.\.\.]] { hosts [FILE [ZONES\.\.\.]] {
[INLINE] [INLINE]
ttl SECONDS
no_reverse
reload DURATION
fallthrough [ZONES\.\.\.] fallthrough [ZONES\.\.\.]
} }
. .
@@ -55,7 +61,16 @@ hosts [FILE [ZONES\.\.\.]] {
\fBZONES\fR zones it should be authoritative for\. If empty, the zones from the configuration block are used\. \fBZONES\fR zones it should be authoritative for\. If empty, the zones from the configuration block are used\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBINLINE\fR the hosts file contents inlined in Corefile\. If there are any lines before fallthrough then all of them will be treated as the additional content for hosts file\. The specified hosts file path will still be read but entries will be overrided\. \fBINLINE\fR the hosts file contents inlined in Corefile\. If there are any lines before fallthrough then all of them will be treated as the additional content for hosts file\. The specified hosts file path will still be read but entries will be overridden\.
.
.IP "\(bu" 4
\fBttl\fR change the DNS TTL of the records generated (forward and reverse)\. The default is 3600 seconds (1 hour)\.
.
.IP "\(bu" 4
\fBreload\fR change the period between each hostsfile reload\. A time of zero seconds disable the feature\. Examples of valid durations: "300ms", "1\.5h" or "2h45m" are valid duration with units "ns" (nanosecond), "us" (or "µs" for microsecond), "ms" (millisecond), "s" (second), "m" (minute), "h" (hour)\.
.
.IP "\(bu" 4
\fBno_reverse\fR disable the automatic generation of the \fBin\-addr\.arpa\fR or \fBip6\.arpa\fR entries for the hosts
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBfallthrough\fR If zone matches and no record can be generated, pass request to the next plugin\. If \fB[ZONES\.\.\.]\fR is omitted, then fallthrough happens for all zones for which the plugin is authoritative\. If specific zones are listed (for example \fBin\-addr\.arpa\fR and \fBip6\.arpa\fR), then only queries for those zones will be subject to fallthrough\. \fBfallthrough\fR If zone matches and no record can be generated, pass request to the next plugin\. If \fB[ZONES\.\.\.]\fR is omitted, then fallthrough happens for all zones for which the plugin is authoritative\. If specific zones are listed (for example \fBin\-addr\.arpa\fR and \fBip6\.arpa\fR), then only queries for those zones will be subject to fallthrough\.

View File

@@ -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\-IMPORT" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-IMPORT" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
. .
.SH "NAME" .SH "NAME"
\fIimport\fR \- include files or reference snippets from a Corefile\. \fIimport\fR \- include files or reference snippets from a Corefile\.
. .
.SH "DESCRIPTION" .SH "DESCRIPTION"
The \fIimport\fR plugin can be used to incude files into the main configuration\. Another use it to reference predefined snippets\. Both can help to avoid some duplication\. The \fIimport\fR 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\.
. .
.P .P
This is a unique directive in that \fIimport\fR 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\. This is a unique directive in that \fIimport\fR 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\.

View 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\-KUBERNETES" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-KUBERNETES" "7" "February 2019" "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\.
@@ -13,7 +13,7 @@ This plugin implements the Kubernetes DNS\-Based Service Discovery Specification
CoreDNS running the kubernetes plugin can be used as a replacement for kube\-dns in a kubernetes cluster\. See the deployment \fIhttps://github\.com/coredns/deployment\fR repository for details on how to deploy CoreDNS in Kubernetes \fIhttps://github\.com/coredns/deployment/tree/master/kubernetes\fR\. CoreDNS running the kubernetes plugin can be used as a replacement for kube\-dns in a kubernetes cluster\. See the deployment \fIhttps://github\.com/coredns/deployment\fR repository for details on how to deploy CoreDNS in Kubernetes \fIhttps://github\.com/coredns/deployment/tree/master/kubernetes\fR\.
. .
.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 \fIhttps://kubernetes\.io/blog/2017/04/configuring\-private\-dns\-zones\-upstream\-nameservers\-kubernetes/\fR are implemented via the \fIproxy\fR plugin and kubernetes \fIupstream\fR\. See example below\.
. .
.P .P
This plugin can only be used once per Server Block\. This plugin can only be used once per Server Block\.
@@ -35,7 +35,7 @@ With only the directive specified, the \fIkubernetes\fR plugin will default to t
kubernetes [ZONES\.\.\.] { kubernetes [ZONES\.\.\.] {
resyncperiod DURATION resyncperiod DURATION
endpoint URL [URL\.\.\.] endpoint URL
tls CERT KEY CACERT tls CERT KEY CACERT
kubeconfig KUBECONFIG CONTEXT kubeconfig KUBECONFIG CONTEXT
namespaces NAMESPACE\.\.\. namespaces NAMESPACE\.\.\.
@@ -58,7 +58,7 @@ kubernetes [ZONES\.\.\.] {
\fBresyncperiod\fR specifies the Kubernetes data API \fBDURATION\fR period\. \fBresyncperiod\fR specifies the Kubernetes data API \fBDURATION\fR period\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBendpoint\fR specifies the \fBURL\fR for a remote k8s API endpoint\. If omitted, it will connect to k8s in\-cluster using the cluster service account\. Multiple k8s API endpoints could be specified: \fBendpoint http://k8s\-endpoint1:8080 http://k8s\-endpoint2:8080\fR\. CoreDNS will automatically perform a healthcheck and proxy to the healthy k8s API endpoint\. \fBendpoint\fR specifies the \fBURL\fR for a remote k8s API endpoint\. If omitted, it will connect to k8s in\-cluster using the cluster service account\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBtls\fR \fBCERT\fR \fBKEY\fR \fBCACERT\fR are the TLS cert, key and the CA cert file names for remote k8s connection\. This option is ignored if connecting in\-cluster (i\.e\. endpoint is not specified)\. \fBtls\fR \fBCERT\fR \fBKEY\fR \fBCACERT\fR are the TLS cert, key and the CA cert file names for remote k8s connection\. This option is ignored if connecting in\-cluster (i\.e\. endpoint is not specified)\.
@@ -70,7 +70,7 @@ kubernetes [ZONES\.\.\.] {
\fBnamespaces\fR \fBNAMESPACE [NAMESPACE\.\.\.]\fR only exposes the k8s namespaces listed\. If this option is omitted all namespaces are exposed \fBnamespaces\fR \fBNAMESPACE [NAMESPACE\.\.\.]\fR only exposes the k8s namespaces listed\. If this option is omitted all namespaces are exposed
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBlabels\fR \fBEXPRESSION\fR only exposes the records for Kubernetes objects that match this label selector\. The label selector syntax is described in the Kubernetes User Guide \- Labels \fIhttp://kubernetes\.io/docs/user\-guide/labels/\fR\. An example that only exposes objects labeled as "application=nginx" in the "staging" or "qa" environments, would use: \fBlabels environment in (staging, qa),application=nginx\fR\. \fBlabels\fR \fBEXPRESSION\fR only exposes the records for Kubernetes objects that match this label selector\. The label selector syntax is described in the Kubernetes User Guide \- Labels \fIhttps://kubernetes\.io/docs/user\-guide/labels/\fR\. An example that only exposes objects labeled as "application=nginx" in the "staging" or "qa" environments, would use: \fBlabels environment in (staging, qa),application=nginx\fR\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBpods\fR \fBPOD\-MODE\fR sets the mode for handling IP\-based pod A records, e\.g\. \fB1\-2\-3\-4\.ns\.pod\.cluster\.local\. in A 1\.2\.3\.4\fR\. This option is provided to facilitate use of SSL certs when connecting directly to pods\. Valid values for \fBPOD\-MODE\fR: \fBpods\fR \fBPOD\-MODE\fR sets the mode for handling IP\-based pod A records, e\.g\. \fB1\-2\-3\-4\.ns\.pod\.cluster\.local\. in A 1\.2\.3\.4\fR\. This option is provided to facilitate use of SSL certs when connecting directly to pods\. Valid values for \fBPOD\-MODE\fR:
@@ -94,28 +94,25 @@ kubernetes [ZONES\.\.\.] {
\fBupstream\fR [\fBADDRESS\fR\.\.\.] defines the upstream resolvers used for resolving services that point to external hosts (aka External Services, aka CNAMEs)\. If no \fBADDRESS\fR is given, CoreDNS will resolve External Services against itself\. \fBADDRESS\fR can be an IP, an IP:port, or a path to a file structured like resolv\.conf\. \fBupstream\fR [\fBADDRESS\fR\.\.\.] defines the upstream resolvers used for resolving services that point to external hosts (aka External Services, aka CNAMEs)\. If no \fBADDRESS\fR is given, CoreDNS will resolve External Services against itself\. \fBADDRESS\fR can be an IP, an IP:port, or a path to a file structured like resolv\.conf\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBttl\fR allows you to set a custom TTL for responses\. The default (and minimum allowed) is 0 seconds, while the maximum is capped at 3600 seconds\. Setting TTL to 0 will prevent records from being cached\. \fBttl\fR allows you to set a custom TTL for responses\. The default is 5 seconds\. The minimum TTL allowed is 0 seconds, and the maximum is capped at 3600 seconds\. Setting TTL to 0 will prevent records from being cached\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBnoendpoints\fR will turn off the serving of endpoint records by disabling the watch on endpoints\. All endpoint queries and headless service queries will result in an NXDOMAIN\. \fBnoendpoints\fR will turn off the serving of endpoint records by disabling the watch on endpoints\. All endpoint queries and headless service queries will result in an NXDOMAIN\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBtransfer\fR enables zone transfers\. It may be specified multiples times\. \fBTo\fR signals the direction (only \fBto\fR is allow)\. \fBADDRESS\fR must be denoted in CIDR notation (127\.0\.0\.1/32 etc\.) or just as plain addresses\. The special wildcard \fB*\fR means: the entire internet\. Sending DNS notifies is not supported\. Deprecated \fIhttps://github\.com/kubernetes/dns/blob/master/docs/specification\.md#26\-\-\-deprecated\-records\fR pod records in the subdomain \fBpod\.cluster\.local\fR are not transferred\. \fBtransfer\fR enables zone transfers\. It may be specified multiples times\. \fBTo\fR signals the direction (only \fBto\fR is allowed)\. \fBADDRESS\fR must be denoted in CIDR notation (127\.0\.0\.1/32 etc\.) or just as plain addresses\. The special wildcard \fB*\fR means: the entire internet\. Sending DNS notifies is not supported\. Deprecated \fIhttps://github\.com/kubernetes/dns/blob/master/docs/specification\.md#26\-\-\-deprecated\-records\fR pod records in the subdomain \fBpod\.cluster\.local\fR are not transferred\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBfallthrough\fR \fB[ZONES\.\.\.]\fR If a query for a record in the zones for which the plugin is authoritative results in NXDOMAIN, normally that is what the response will be\. However, if you specify this option, the query will instead be passed on down the plugin chain, which can include another plugin to handle the query\. If \fB[ZONES\.\.\.]\fR is omitted, then fallthrough happens for all zones for which the plugin is authoritative\. If specific zones are listed (for example \fBin\-addr\.arpa\fR and \fBip6\.arpa\fR), then only queries for those zones will be subject to fallthrough\. \fBfallthrough\fR \fB[ZONES\.\.\.]\fR If a query for a record in the zones for which the plugin is authoritative results in NXDOMAIN, normally that is what the response will be\. However, if you specify this option, the query will instead be passed on down the plugin chain, which can include another plugin to handle the query\. If \fB[ZONES\.\.\.]\fR is omitted, then fallthrough happens for all zones for which the plugin is authoritative\. If specific zones are listed (for example \fBin\-addr\.arpa\fR and \fBip6\.arpa\fR), then only queries for those zones will be subject to fallthrough\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBignore empty_service\fR return NXDOMAIN for services without any ready endpoint addresses (e\.g\., ready pods)\. This allows the querying pod to continue searching for the service in the search path\. The search path could, for example, include another Kubernetes cluster\. \fBignore empty_service\fR returns NXDOMAIN for services without any ready endpoint addresses (e\.g\., ready pods)\. This allows the querying pod to continue searching for the service in the search path\. The search path could, for example, include another Kubernetes cluster\.
. .
.IP "" 0 .IP "" 0
. .
.SH "HEALTH" .SH "HEALTH"
This plugin implements dynamic health checking\. Currently this is limited to reporting healthy when the API has synced\. This plugin implements dynamic health checking\. Currently this is limited to reporting healthy when the API has synced\.
. .
.SH "WATCH"
This plugin implements watch\. A client that connects to CoreDNS using \fBcoredns/client\fR can be notified of changes to A, AAAA, and SRV records for Kubernetes services and endpoints\.
.
.SH "EXAMPLES" .SH "EXAMPLES"
Handle all queries in the \fBcluster\.local\fR zone\. Connect to Kubernetes in\-cluster\. Also handle all \fBin\-addr\.arpa\fR \fBPTR\fR requests for \fB10\.0\.0\.0/17\fR \. Verify the existence of pods when answering pod requests\. Resolve upstream records against \fB10\.102\.3\.10\fR\. Note we show the entire server block here: Handle all queries in the \fBcluster\.local\fR zone\. Connect to Kubernetes in\-cluster\. Also handle all \fBin\-addr\.arpa\fR \fBPTR\fR requests for \fB10\.0\.0\.0/17\fR \. Verify the existence of pods when answering pod requests\. Resolve upstream records against \fB10\.102\.3\.10\fR\. Note we show the entire server block here:
. .
@@ -253,7 +250,7 @@ Some query labels accept a wildcard value to match any value\. If a label is a v
\fIport and/or protocol\fR in an \fBSRV\fR request: \fBport_\.\fRprotocol_\.service\.namespace\.svc\.zone\., e\.g\., \fB_http\.*\.service\.ns\.svc\.cluster\.local\fR \fIport and/or protocol\fR in an \fBSRV\fR request: \fBport_\.\fRprotocol_\.service\.namespace\.svc\.zone\., e\.g\., \fB_http\.*\.service\.ns\.svc\.cluster\.local\fR
. .
.IP "\(bu" 4 .IP "\(bu" 4
multiple wild cards are allowed in a single query, e\.g\., \fBA\fR Request \fB*\.*\.svc\.zone\.\fR or \fBSRV\fR request \fB*\.*\.*\.*\.svc\.zone\.\fR multiple wildcards are allowed in a single query, e\.g\., \fBA\fR Request \fB*\.*\.svc\.zone\.\fR or \fBSRV\fR request \fB*\.*\.*\.*\.svc\.zone\.\fR
. .
.IP "" 0 .IP "" 0
. .

View 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\-LOG" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-LOG" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
. .
.SH "NAME" .SH "NAME"
\fIlog\fR \- enables query logging to standard output\. \fIlog\fR \- enables query logging to standard output\.
@@ -32,14 +32,14 @@ Or if you want/need slightly more control:
. .
.nf .nf
log [NAME] [FORMAT] log [NAMES\.\.\.] [FORMAT]
. .
.fi .fi
. .
.IP "" 0 .IP "" 0
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBNAME\fR is the name to match in order to be logged \fBNAMES\fR is the name list to match in order to be logged
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBFORMAT\fR is the log format to use (default is Common Log Format), \fB{common}\fR is used as a shortcut for the Common Log Format\. You can also use \fB{combined}\fR for a format that adds the query opcode \fB{>opcode}\fR to the Common Log Format\. \fBFORMAT\fR is the log format to use (default is Common Log Format), \fB{common}\fR is used as a shortcut for the Common Log Format\. You can also use \fB{combined}\fR for a format that adds the query opcode \fB{>opcode}\fR to the Common Log Format\.
@@ -53,7 +53,7 @@ You can further specify the classes of responses that get logged:
. .
.nf .nf
log [NAME] [FORMAT] { log [NAMES\.\.\.] [FORMAT] {
class CLASSES\.\.\. class CLASSES\.\.\.
} }
. .

View 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\-METRICS" "7" "October 2018" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-METRICS" "7" "February 2019" "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\.
@@ -79,10 +79,10 @@ prometheus [ADDRESS]
For each zone that you want to see metrics for\. For each zone that you want to see metrics for\.
. .
.P .P
It optionally takes an address to which the metrics are exported; the default is \fBlocalhost:9153\fR\. The metrics path is fixed to \fB/metrics\fR\. It optionally takes a bind address to which the metrics are exported; the default listens on \fBlocalhost:9153\fR\. The metrics path is fixed to \fB/metrics\fR\.
. .
.SH "EXAMPLES" .SH "EXAMPLES"
Use an alternative address: Use an alternative listening address:
. .
.IP "" 4 .IP "" 4
. .

View 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\-PROXY" "7" "October 2018" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-PROXY" "7" "February 2019" "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\.
@@ -81,7 +81,24 @@ proxy FROM TO\.\.\. {
.IP "" 0 .IP "" 0
. .
.SH "POLICIES" .SH "POLICIES"
There are four load\-balancing policies available: * \fBrandom\fR (default) \- Randomly select a backend * \fBleast_conn\fR \- Select the backend with the fewest active connections * \fBround_robin\fR \- Select the backend in round\-robin fashion * \fBsequential\fR \- Select the first available backend looking by order of declaration from left to right * \fBfirst\fR \- Deprecated\. Use sequential instead There are four load\-balancing policies available:
.
.IP "\(bu" 4
\fBrandom\fR (default) \- Randomly select a backend
.
.IP "\(bu" 4
\fBleast_conn\fR \- Select the backend with the fewest active connections
.
.IP "\(bu" 4
\fBround_robin\fR \- Select the backend in round\-robin fashion
.
.IP "\(bu" 4
\fBsequential\fR \- Select the first available backend looking by order of declaration from left to right
.
.IP "\(bu" 4
\fBfirst\fR \- Deprecated\. Use sequential instead
.
.IP "" 0
. .
.P .P
All polices implement randomly spraying packets to backend hosts when \fIno healthy\fR hosts are available\. This is to preeempt the case where the healthchecking (as a mechanism) fails\. All polices implement randomly spraying packets to backend hosts when \fIno healthy\fR hosts are available\. This is to preeempt the case where the healthchecking (as a mechanism) fails\.

View 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\-REWRITE" "7" "December 2018" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-REWRITE" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
. .
.SH "NAME" .SH "NAME"
\fIrewrite\fR \- performs internal message rewriting\. \fIrewrite\fR \- performs internal message rewriting\.
@@ -258,7 +258,7 @@ rewrite [continue|stop] {
.IP "" 0 .IP "" 0
. .
.P .P
Note that the above syntax is strict\. For response rewrites only \fBname\fR rules are allowed to match the question section, and only by match type \fBregex\fR\. The answer rewrite must be after the name, as ordered in the syntax example\. There must only be two lines (a \fBname\fR follwed by an \fBanswer\fR) in the brackets, additional rules are not supported\. Note that the above syntax is strict\. For response rewrites only \fBname\fR rules are allowed to match the question section, and only by match type \fBregex\fR\. The answer rewrite must be after the name, as ordered in the syntax example\. There must only be two lines (a \fBname\fR followed by an \fBanswer\fR) in the brackets, additional rules are not supported\.
. .
.P .P
An alternate syntax for the rewrite of DNS request and response is as follows: An alternate syntax for the rewrite of DNS request and response is as follows:

View File

@@ -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\-ROUTE53" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-ROUTE53" "7" "February 2019" "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\.
. .
.SH "DESCRIPTION" .SH "DESCRIPTION"
The route53 plugin is useful for serving zones from resource record sets in AWS route53\. This plugin supports all Amazon Route 53 records (https://docs\.aws\.amazon\.com/Route53/latest/DeveloperGuide/ResourceRecordTypes\.html)\. The route53 plugin can be used when coredns is deployed on AWS or elsewhere\. The route53 plugin is useful for serving zones from resource record sets in AWS route53\. This plugin supports all Amazon Route 53 records (\fIhttps://docs\.aws\.amazon\.com/Route53/latest/DeveloperGuide/ResourceRecordTypes\.html\fR)\. The route53 plugin can be used when coredns is deployed on AWS or elsewhere\.
. .
.SH "SYNTAX" .SH "SYNTAX"
. .
@@ -15,7 +15,7 @@ The route53 plugin is useful for serving zones from resource record sets in AWS
route53 [ZONE:HOSTED_ZONE_ID\.\.\.] { route53 [ZONE:HOSTED_ZONE_ID\.\.\.] {
[aws_access_key AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY] [aws_access_key AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY]
upstream [ADDRESS\.\.\.] upstream
credentials PROFILE [FILENAME] credentials PROFILE [FILENAME]
fallthrough [ZONES\.\.\.] fallthrough [ZONES\.\.\.]
} }
@@ -26,16 +26,16 @@ route53 [ZONE:HOSTED_ZONE_ID\.\.\.] {
\fBZONE\fR the name of the domain to be accessed\. When there are multiple zones with overlapping domains (private vs\. public hosted zone), CoreDNS does the lookup in the given order here\. Therefore, for a non\-existing resource record, SOA response will be from the rightmost zone\. \fBZONE\fR the name of the domain to be accessed\. When there are multiple zones with overlapping domains (private vs\. public hosted zone), CoreDNS does the lookup in the given order here\. Therefore, for a non\-existing resource record, SOA response will be from the rightmost zone\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBHOSTED_ZONE_ID\fR the ID of the hosted zone that contains the resource record sets to be accessed\. \fBHOSTED\fIZONE\fRID\fR the ID of the hosted zone that contains the resource record sets to be accessed\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBAWS_ACCESS_KEY_ID\fR and \fBAWS_SECRET_ACCESS_KEY\fR the AWS access key ID and secret access key to be used when query AWS (optional)\. If they are not provided, then coredns tries to access AWS credentials the same way as AWS CLI, e\.g\., environmental variables, AWS credentials file, instance profile credentials, etc\. \fBAWS\fIACCESS\fRKEY_ID\fR and \fBAWS\fISECRET\fRACCESS_KEY\fR the AWS access key ID and secret access key to be used when query AWS (optional)\. If they are not provided, then coredns tries to access AWS credentials the same way as AWS CLI, e\.g\., environmental variables, AWS credentials file, instance profile credentials, etc\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBupstream\fR [\fBADDRESS\fR\.\.\.] specifies upstream resolver(s) used for resolving services that point to external hosts (eg\. used to resolve CNAMEs)\. If no \fBADDRESS\fR is given, CoreDNS will resolve against itself\. \fBADDRESS\fR can be an IP, an IP:port or a path to a file structured like resolv\.conf\. \fBupstream\fRis used for resolving services that point to external hosts (eg\. used to resolve CNAMEs)\. CoreDNS will resolve against itself\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBcredentials\fR used for reading the credential file and setting the profile name for a given zone\. \fBcredentials\fR is used for reading the credential file and setting the profile name for a given zone\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBPROFILE\fR AWS account profile name\. Defaults to \fBdefault\fR\. \fBPROFILE\fR AWS account profile name\. Defaults to \fBdefault\fR\.

View 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\-SECONDARY" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-SECONDARY" "7" "February 2019" "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\.
@@ -34,7 +34,7 @@ A working syntax would be:
secondary [zones\.\.\.] { secondary [zones\.\.\.] {
transfer from ADDRESS transfer from ADDRESS
transfer to ADDRESS transfer to ADDRESS
upstream [ADDRESS\.\.\.] upstream
} }
. .
.fi .fi
@@ -48,7 +48,7 @@ secondary [zones\.\.\.] {
\fBtransfer to\fR can be enabled to allow this secondary zone to be transferred again\. \fBtransfer to\fR can be enabled to allow this secondary zone to be transferred again\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBupstream\fR defines upstream resolvers to be used resolve external names found (think CNAMEs) pointing to external names\. This is only really useful when CoreDNS is configured as a proxy, for normal authoritative serving you don\'t need \fIor\fR want to use this\. \fBADDRESS\fR can be an IP address, and IP:port or a string pointing to a file that is structured as /etc/resolv\.conf\. If no \fBADDRESS\fR is given, CoreDNS will resolve CNAMEs against itself\. \fBupstream\fR resolve external names found (think CNAMEs) pointing to external names\. This is only really useful when CoreDNS is configured as a proxy; for normal authoritative serving you don\'t need \fIor\fR want to use this\. CoreDNS will resolve CNAMEs against itself\.
. .
.IP "" 0 .IP "" 0
. .

View 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\-TEMPLATE" "7" "January 2019" "CoreDNS" "CoreDNS plugins" .TH "COREDNS\-TEMPLATE" "7" "February 2019" "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\.
@@ -14,14 +14,13 @@ The \fItemplate\fR plugin allows you to dynamically respond to queries by just w
.nf .nf
template CLASS TYPE [ZONE\.\.\.] { template CLASS TYPE [ZONE\.\.\.] {
[match REGEX\.\.\.] match REGEX\.\.\.
[answer RR] answer RR
[additional RR] additional RR
[authority RR] authority RR
[\.\.\.] rcode CODE
[rcode CODE] upstream
[upstream [ADDRESS\.\.\.]] fallthrough [ZONE\.\.\.]
[fallthrough [ZONE\.\.\.]]
} }
. .
.fi .fi
@@ -45,7 +44,7 @@ template CLASS TYPE [ZONE\.\.\.] {
\fBrcode\fR \fBCODE\fR A response code (\fBNXDOMAIN, SERVFAIL, \.\.\.\fR)\. The default is \fBSUCCESS\fR\. \fBrcode\fR \fBCODE\fR A response code (\fBNXDOMAIN, SERVFAIL, \.\.\.\fR)\. The default is \fBSUCCESS\fR\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBupstream\fR [\fBADDRESS\fR\.\.\.] defines the upstream resolvers used for resolving CNAME\. If no \fBADDRESS\fR is given, CoreDNS will resolve CNAMEs against itself\. \fBADDRESS\fR can be an IP, an IP:port, or a path to a file structured like resolv\.conf\. \fBupstream\fR defines the upstream resolvers used for resolving CNAMEs\. CoreDNS will resolve CNAMEs against itself\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBfallthrough\fR Continue with the next plugin if the zone matched but no regex matched\. If specific zones are listed (for example \fBin\-addr\.arpa\fR and \fBip6\.arpa\fR), then only queries for those zones will be subject to fallthrough\. \fBfallthrough\fR Continue with the next plugin if the zone matched but no regex matched\. If specific zones are listed (for example \fBin\-addr\.arpa\fR and \fBip6\.arpa\fR), then only queries for those zones will be subject to fallthrough\.
@@ -226,19 +225,19 @@ The regex\-based version can do more complex matching/templating while zone\-bas
\&\. { \&\. {
proxy \. 8\.8\.8\.8 proxy \. 8\.8\.8\.8
# ip\-a\-b\-c\-d\.example\.com A a\.b\.c\.d # ip\-a\-b\-c\-d\.example A a\.b\.c\.d
template IN A example { template IN A example {
match (^|[\.])ip\-10\-(?P<b>[0\-9]*)\-(?P<c>[0\-9]*)\-(?P<d>[0\-9]*)[\.]example[\.]$ match (^|[\.])ip\-(?P<a>[0\-9]*)\-(?P<b>[0\-9]*)\-(?P<c>[0\-9]*)\-(?P<d>[0\-9]*)[\.]example[\.]$
answer "{{ \.Name }} 60 IN A 10\.{{ \.Group\.b }}\.{{ \.Group\.c }}\.{{ \.Group\.d }}" answer "{{ \.Name }} 60 IN A {{ \.Group\.a }}\.{{ \.Group\.b }}\.{{ \.Group\.c }}\.{{ \.Group\.d }}"
fallthrough fallthrough
} }
# d\.c\.b\.a\.in\-addr\.arpa PTR ip\-a\-b\-c\-d\.example # d\.c\.b\.a\.in\-addr\.arpa PTR ip\-a\-b\-c\-d\.example
template IN PTR 10\.in\-addr\.arpa\. { template IN PTR in\-addr\.arpa {
match ^(?P<d>[0\-9]*)[\.](?P<c>[0\-9]*)[\.](?P<b>[0\-9]*)[\.]10[\.]in\-addr[\.]arpa[\.]$ match ^(?P<d>[0\-9]*)[\.](?P<c>[0\-9]*)[\.](?P<b>[0\-9]*)[\.](?P<a>[0\-9]*)[\.]in\-addr[\.]arpa[\.]$
answer "{{ \.Name }} 60 IN PTR ip\-10\-{{ \.Group\.b }}\-{{ \.Group\.c }}\-{{ \.Group\.d }}\.example\.com\." answer "{{ \.Name }} 60 IN PTR ip\-{{ \.Group\.a }}\-{{ \.Group\.b }}\-{{ \.Group\.c }}\-{{ \.Group\.d }}\.example\."
} }
} }
. .