mirror of
https://github.com/coredns/coredns.git
synced 2025-10-27 16:24:19 -04:00
auto make -f Makefile.doc
This commit is contained in:
@@ -7,14 +7,14 @@
|
||||
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
If it sees a query that matches the first element of the configured search path, \fIautopath\fP will
|
||||
If the \fIautopath\fP plugin sees a query that matches the first element of the configured search path, it 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
|
||||
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.
|
||||
|
||||
.PP
|
||||
\fBNote\fP: There are several known issues. See section below.
|
||||
\fBNote\fP: There are several known issues, see the "Bugs" section below.
|
||||
|
||||
.SH "SYNTAX"
|
||||
.PP
|
||||
@@ -35,7 +35,7 @@ query) to retrieve the search list it should use.
|
||||
|
||||
|
||||
.PP
|
||||
If a plugin implements the \fB\fCAutoPather\fR interface then it can be used.
|
||||
If a plugin implements the \fB\fCAutoPather\fR interface then it can be used by \fIautopath\fP.
|
||||
|
||||
.SH "METRICS"
|
||||
.PP
|
||||
@@ -74,21 +74,22 @@ autopath @kubernetes
|
||||
.PP
|
||||
Use the search path dynamically retrieved from the \fIkubernetes\fP plugin.
|
||||
|
||||
.SH "KNOWN ISSUES"
|
||||
.SH "BUGS"
|
||||
.PP
|
||||
In Kubernetes, \fIautopath\fP can derive the wrong namespace of a client Pod (and therefore wrong search path)
|
||||
in the following case. To properly build the search path of a client \fIautopath\fP needs to
|
||||
know the namespace of the a Pod making a DNS request. To do this, it relies on the
|
||||
\fIkubernetes\fP plugin's Pod cache to resolve the client's IP address to a Pod. The Pod cache is maintained by
|
||||
an API watch on Pods. When Pod IP assignments change, the Kubernetes API notifies CoreDNS via the API watch.
|
||||
In Kubernetes, \fIautopath\fP can derive the wrong namespace of a client Pod (and therefore wrong search
|
||||
path) in the following case. To properly build the search path of a client \fIautopath\fP needs to know
|
||||
the namespace of the a Pod making a DNS request. To do this, it relies on the \fIkubernetes\fP plugin's
|
||||
Pod cache to resolve the client's IP address to a Pod. The Pod cache is maintained by an API watch
|
||||
on Pods. When Pod IP assignments change, the Kubernetes API notifies CoreDNS via the API watch.
|
||||
However, that notification is not instantaneous. In the case that a Pod is deleted, and it's IP is
|
||||
immediately provisioned to a Pod in another namespace, and that new Pod make a DNS lookup \fIbefore\fP the API watch
|
||||
can notify CoreDNS of the change, \fIautopath\fP will resolve the IP to the previous Pod's namespace.
|
||||
immediately provisioned to a Pod in another namespace, and that new Pod make a DNS lookup \fIbefore\fP
|
||||
the API watch can notify CoreDNS of the change, \fIautopath\fP will resolve the IP to the previous Pod's
|
||||
namespace.
|
||||
|
||||
.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.
|
||||
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.
|
||||
|
||||
|
||||
@@ -50,6 +50,19 @@ trace [ENDPOINT\-TYPE] [ENDPOINT] {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
trace datadog {
|
||||
every AMOUNT
|
||||
service NAME
|
||||
datadog\_analytics\_rate RATE
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.IP \(bu 4
|
||||
\fB\fCevery\fR \fBAMOUNT\fP will only trace one query of each AMOUNT queries. For example, to trace 1 in every
|
||||
100 queries, use AMOUNT of 100. The default is 1.
|
||||
@@ -58,6 +71,10 @@ trace [ENDPOINT\-TYPE] [ENDPOINT] {
|
||||
Default is \fB\fCcoredns\fR.
|
||||
.IP \(bu 4
|
||||
\fB\fCclient_server\fR will enable the \fB\fCClientServerSameSpan\fR OpenTracing feature.
|
||||
.IP \(bu 4
|
||||
\fB\fCdatadog_analytics_rate\fR \fBRATE\fP will enable trace analytics
|
||||
\[la]https://docs.datadoghq.com/tracing/app_analytics\[ra] on the traces sent
|
||||
from \fI0\fP to \fI1\fP, \fI1\fP being every trace sent will be analyzed. This is a datadog only feature.
|
||||
|
||||
|
||||
.SH "ZIPKIN"
|
||||
|
||||
Reference in New Issue
Block a user