mirror of
https://github.com/coredns/coredns.git
synced 2025-12-05 09:55:10 -05:00
docs: Regenerate all manpages using mmark (#2762)
Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
GitHub
@@ -1,67 +1,81 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "COREDNS\-AUTOPATH" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fIautopath\fR \- allows for server\-side search path completion\.
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
If it sees a query that matches the first element of the configured search path, \fIautopath\fR will follow the chain of search path elements and return the first reply that is not NXDOMAIN\. On any failures, the original reply is returned\. Because \fIautopath\fR returns a reply for a name that wasn\'t the original question it will add a CNAME that points from the original name (with the search path element in it) to the name of this answer\.
|
||||
.
|
||||
.SH "SYNTAX"
|
||||
.
|
||||
.nf
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-AUTOPATH" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH AUTOPATH
|
||||
.SH NAME
|
||||
.PP
|
||||
\fIautopath\fP - allows for server-side search path completion.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
If it sees a query that matches the first element of the configured search path, \fIautopath\fP will
|
||||
follow the chain of search path elements and return the first reply that is not NXDOMAIN. On any
|
||||
failures, the original reply is returned. Because \fIautopath\fP returns a reply for a name that wasn't
|
||||
the original question it will add a CNAME that points from the original name (with the search path
|
||||
element in it) to the name of this answer.
|
||||
|
||||
.SH SYNTAX
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
autopath [ZONE...] RESOLV\-CONF
|
||||
|
||||
autopath [ZONE\.\.\.] RESOLV\-CONF
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBZONES\fR zones \fIautopath\fR should be authoritative for\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBRESOLV\-CONF\fR points to a \fBresolv\.conf\fR like file or uses a special syntax to point to another plugin\. For instance \fB@kubernetes\fR, will call out to the kubernetes plugin (for each query) to retrieve the search list it should use\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If a plugin implements the \fBAutoPather\fR interface then it can be used\.
|
||||
.
|
||||
.SH "METRICS"
|
||||
If monitoring is enabled (via the \fIprometheus\fR directive) then the following metric is exported:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBcoredns_autopath_success_count_total{server}\fR \- counter of successfully autopath\-ed queries\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The \fBserver\fR label is explained in the \fImetrics\fR plugin documentation\.
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.IP \(bu 4
|
||||
\fBZONES\fP zones \fIautopath\fP should be authoritative for.
|
||||
.IP \(bu 4
|
||||
\fBRESOLV-CONF\fP points to a \fB\fCresolv.conf\fR like file or uses a special syntax to point to another
|
||||
plugin. For instance \fB\fC@kubernetes\fR, will call out to the kubernetes plugin (for each
|
||||
query) to retrieve the search list it should use.
|
||||
|
||||
|
||||
.PP
|
||||
If a plugin implements the \fB\fCAutoPather\fR interface then it can be used.
|
||||
|
||||
.SH METRICS
|
||||
.PP
|
||||
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric is exported:
|
||||
|
||||
.IP \(bu 4
|
||||
\fB\fCcoredns_autopath_success_count_total{server}\fR - counter of successfully autopath-ed queries.
|
||||
|
||||
|
||||
.PP
|
||||
The \fB\fCserver\fR label is explained in the \fImetrics\fP plugin documentation.
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
autopath my\-resolv.conf
|
||||
|
||||
autopath my\-resolv\.conf
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.P
|
||||
Use \fBmy\-resolv\.conf\fR as the file to get the search path from\. This file only needs so have one line: \fBsearch domain1 domain2 \.\.\.\fR
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Use \fB\fCmy-resolv.conf\fR as the file to get the search path from. This file only needs so have one line:
|
||||
\fB\fCsearch domain1 domain2 ...\fR
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
autopath @kubernetes
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Use the search path dynamically retrieved from the \fIkubernetes\fR plugin\.
|
||||
.
|
||||
.SH "KNOWN ISSUES"
|
||||
Autopath is not compatible with pods running from Windows nodes\.
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Use the search path dynamically retrieved from the \fIkubernetes\fP plugin.
|
||||
|
||||
.SH KNOWN ISSUES
|
||||
.PP
|
||||
In Kubernetes, \fIautopath\fP is not compatible with pods running from Windows nodes.
|
||||
|
||||
.PP
|
||||
If the server side search ultimately results in a negative answer (e.g. \fB\fCNXDOMAIN\fR), then the client will fruitlessly search all paths manually, thus negating the \fIautopath\fP optimization.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user