Commit b7476d02 authored by Miek Gieben's avatar Miek Gieben Committed by GitHub

Doc (#1369)

* Constent atx headers

* Regen manual pages
parent 48059a6c
......@@ -108,4 +108,6 @@ Listen for dnstap messages on port 6000\.
.fi
.
.IP "" 0
.
.SH "SEE ALSO"
dnstap\.info \fIhttp://dnstap\.info\fR\.
......@@ -37,7 +37,7 @@ If you want to \fBround robin\fR A and AAAA responses look at the \fBloadbalance
etcd [ZONES\.\.\.] {
stubzones
fallthrough
fallthrough [ZONES\.\.\.]
path PATH
endpoint ENDPOINT\.\.\.
upstream ADDRESS\.\.\.
......@@ -52,7 +52,7 @@ etcd [ZONES\.\.\.] {
\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\.
\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
\fBPATH\fR the path inside etcd\. Defaults to "/skydns"\.
......@@ -184,4 +184,6 @@ reverse\.skydns\.local\.
.fi
.
.IP "" 0
.
.SH "BUGS"
Only the etcdv2 protocol is supported\.
......@@ -4,9 +4,12 @@
.TH "COREDNS\-FEDERATION" "7" "January 2018" "CoreDNS" "CoreDNS plugins"
.
.SH "NAME"
\fIfederation\fR \- enables federated \fIhttps://kubernetes\.io/docs/tasks/federation/federation\-service\-discovery/\fR queries to be resolved via the kubernetes plugin\.
\fIfederation\fR \- enables federated queries to be resolved via the kubernetes plugin\.
.
.SH "DESCRIPTION"
Enabling this plugin allows Federated \fIhttps://kubernetes\.io/docs/tasks/federation/federation\-service\-discovery/\fR queries to be resolved via the kubernetes plugin\.
.
.P
Enabling \fIfederation\fR without also having \fIkubernetes\fR is a noop\.
.
.SH "SYNTAX"
......
......@@ -15,7 +15,7 @@ The hosts plugin is useful for serving zones from a /etc/hosts file\. It serves
hosts [FILE [ZONES\.\.\.]] {
[INLINE]
fallthrough
fallthrough [ZONES\.\.\.]
}
.
.fi
......@@ -30,7 +30,7 @@ hosts [FILE [ZONES\.\.\.]] {
\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\.
.
.IP "\(bu" 4
\fBfallthrough\fR If zone matches and no record can be generated, pass request to the next plugin\.
\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\.
.
.IP "" 0
.
......
......@@ -40,7 +40,7 @@ kubernetes [ZONES\.\.\.] {
endpoint_pod_names
upstream ADDRESS\.\.\.
ttl TTL
fallthrough
fallthrough [ZONES\.\.\.]
}
.
.fi
......@@ -87,7 +87,7 @@ kubernetes [ZONES\.\.\.] {
\fBttl\fR allows you to set a custom TTL for responses\. The default (and allowed minimum) is to use 5 seconds, the maximum is capped at 3600 seconds\.
.
.IP "\(bu" 4
\fBfallthrough\fR If a query for a record in the cluster zone 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\.
\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 "" 0
.
......
......@@ -4,7 +4,7 @@
.TH "COREDNS\-LOG" "7" "January 2018" "CoreDNS" "CoreDNS plugins"
.
.SH "NAME"
\fIlog\fR enables query logging to standard output\.
\fIlog\fR \- enables query logging to standard output\.
.
.SH "DESCRIPTION"
By just using \fIlog\fR you dump all queries (and parts for the reply) on standard output\. Options exist to tweak the output a little\.
......
......@@ -98,4 +98,6 @@ Or via an enviroment variable (this is supported throughout the Corefile): \fBex
.fi
.
.IP "" 0
.
.SH "BUGS"
When reloading, we keep the handler running, meaning that any changes to the handler\'s address aren\'t picked up\. You\'ll need to restart CoreDNS for that to happen\.
......@@ -67,4 +67,6 @@ Listen on an all addresses on port 6060:
.fi
.
.IP "" 0
.
.SH "ALSO SEE"
See Go\'s pprof documentation \fIhttps://golang\.org/pkg/net/http/pprof/\fR and Profiling Go Programs \fIhttps://blog\.golang\.org/profiling\-go\-programs\fR\.
......@@ -271,4 +271,6 @@ example\.org {
.fi
.
.IP "" 0
.
.SH "BUGS"
When using the \fBgoogle_https\fR protocol the health checking will health check the wrong endpoint\. See \fIhttps://github\.com/coredns/coredns/issues/1202\fR for some background\.
......@@ -16,7 +16,7 @@ If a request matches a regular expression (see Template Syntax below) this plugi
reverse NETWORK\.\.\. {
hostname TEMPLATE
[ttl TTL]
[fallthrough]
[fallthrough [ZONES\.\.\.]]
[wildcard]
.
.fi
......@@ -31,7 +31,7 @@ reverse NETWORK\.\.\. {
\fBttl\fR defaults to 60
.
.IP "\(bu" 4
\fBfallthrough\fR if zone matches and no record can be generated, pass request to the next plugin\.
\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\.
.
.IP "\(bu" 4
\fBwildcard\fR allows matches to catch all subdomains as well\.
......
......@@ -87,4 +87,6 @@ Or re\-export the retrieved zone to other secondaries\.
.fi
.
.IP "" 0
.
.SH "BUGS"
Only AXFR is supported and the retrieved zone is not committed to disk\.
This diff is collapsed.
......@@ -56,4 +56,4 @@ CoreDNS Authors\.
Apache License 2\.0
.
.SH "SEE ALSO"
Corefile(7) corendns\-debug(7) corendns\-dnssec(7) corendns\-health(7) corendns\-log(7) corendns\-file(7) corendns\-nsid(7) corendns\-autopath(7) corendns\-auto(7) corendns\-erratic(7) corendns\-chaos(7) corendns\-dnstap(7) corendns\-pprof(7) corendns\-tls(7) corendns\-loadbalance(7) corendns\-cache(7) corendns\-root(7) corendns\-whoami(7) corendns\-bind(7) corendns\-hosts(7) corendns\-proxy(7) corendns\-kubernetes(7) corendns\-secondary(7) corendns\-reverse(7) corendns\-errors(7) corendns\-metrics(7) corendns\-rewrite(7) corendns\-federation(7) corendns\-etcd(7) corendns\-trace(7)\.
Corefile(5) corendns\-debug(7) corendns\-dnssec(7) corendns\-health(7) corendns\-log(7) corendns\-file(7) corendns\-nsid(7) corendns\-auto(7) corendns\-erratic(7) corendns\-chaos(7) corendns\-dnstap(7) corendns\-pprof(7) corendns\-tls(7) corendns\-loadbalance(7) corendns\-cache(7) corendns\-root(7) corendns\-whoami(7) corendns\-bind(7) corendns\-hosts(7) corendns\-template(7) corendns\-proxy(7) corendns\-autopath(7) corendns\-kubernetes(7) corendns\-secondary(7) corendns\-reverse(7) corendns\-errors(7) corendns\-metrics(7) corendns\-rewrite(7) corendns\-federation(7) corendns\-etcd(7) corendns\-trace(7)\.
......@@ -64,6 +64,6 @@ Listen for dnstap messages on port 6000.
% dnstap -l 127.0.0.1:6000
~~~
# See Also
## See Also
[dnstap.info](http://dnstap.info).
......@@ -127,6 +127,6 @@ Querying with dig:
reverse.skydns.local.
~~~
# Bugs
## Bugs
Only the etcdv2 protocol is supported.
......@@ -62,7 +62,7 @@ then:
}
~~~
# Bugs
## Bugs
When reloading, we keep the handler running, meaning that any changes to the handler's address
aren't picked up. You'll need to restart CoreDNS for that to happen.
......@@ -50,7 +50,7 @@ Listen on an all addresses on port 6060:
}
~~~
# Also See
## Also See
See [Go's pprof documentation](https://golang.org/pkg/net/http/pprof/) and [Profiling Go
Programs](https://blog.golang.org/profiling-go-programs).
......@@ -195,7 +195,7 @@ example.org {
}
~~~
# Bugs
## Bugs
When using the `google_https` protocol the health checking will health check the wrong endpoint.
See <https://github.com/coredns/coredns/issues/1202> for some background.
......@@ -59,6 +59,6 @@ Or re-export the retrieved zone to other secondaries.
}
~~~
# Bugs
## Bugs
Only AXFR is supported and the retrieved zone is not committed to disk.
# template
## Name
*template* - allows for dynamic responses based on the incoming query.
## Description
......@@ -233,14 +235,14 @@ Named capture groups can be used to template one response for multiple patterns.
}
~~~
# Also see
## Also see
- [Go regexp](https://golang.org/pkg/regexp/) for details about the regex implementation
- [RE2 syntax reference](https://github.com/google/re2/wiki/Syntax) for details about the regex syntax
- [RFC-1034](https://tools.ietf.org/html/rfc1034#section-3.6.1) and [RFC 1035](https://tools.ietf.org/html/rfc1035#section-5) for the resource record format
- [Go template](https://golang.org/pkg/text/template/) for the template language reference
# Bugs
## Bugs
CoreDNS supports [caddyfile environment variables](https://caddyserver.com/docs/caddyfile#env)
with notion of `{$ENV_VAR}`. This parser feature will break [Go template variables](https://golang.org/pkg/text/template/#hdr-Variables) notations like`{{$variable}}`.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment