auto make -f Makefile.doc

man/coredns-etcd.7

@@ -9,7 +9,8 @@
 .PP
 The \fIetcd\fP plugin implements the (older) SkyDNS service discovery service. It is \fInot\fP suitable as
 a generic DNS zone data plugin. Only a subset of DNS record types are implemented, and subdomains
-and delegations are not handled at all.
+and delegations are not handled at all. The plugin will also recursively descend the tree and return
+all records found, see "Special Behavior" below for details.
 
 .PP
 The data in the etcd instance has to be encoded as
@@ -19,8 +20,8 @@ like SkyDNS
 \[la]https://github.com/skynetservices/skydns\[ra]. It works just like SkyDNS.
 
 .PP
-The etcd plugin makes extensive use of the \fIforward\fP plugin to forward and query other servers in the
-network.
+The \fIetcd\fP plugin makes extensive use of the \fIforward\fP plugin to forward and query other servers in the
+network - if that plugin has been enabled as well.
 
 .SH "SYNTAX"
 .PP
@@ -41,9 +42,6 @@ The path will default to \fB\fC/skydns\fR the local etcd3 proxy (http://localhos
 \[la]http://localhost:2379\[ra]). If no zones are
 specified the block's zone will be used as the zone.
 
-.PP
-If you want to \fB\fCround robin\fR A and AAAA responses look at the \fB\fCloadbalance\fR plugin.
-
 .PP
 .RS
 
@@ -94,19 +92,21 @@ is needed.
 The \fIetcd\fP plugin leverages directory structure to look for related entries. For example
 an entry \fB\fC/skydns/test/skydns/mx\fR would have entries like \fB\fC/skydns/test/skydns/mx/a\fR,
 \fB\fC/skydns/test/skydns/mx/b\fR and so on. Similarly a directory \fB\fC/skydns/test/skydns/mx1\fR will have all
-\fB\fCmx1\fR entries.
+\fB\fCmx1\fR entries. Note this plugin will search through the entire (sub)tree for records. In case of the
+first example, a query for \fB\fCmx.skydns.text\fR will return both the contents of the \fB\fCa\fR and \fB\fCb\fR records.
+If the directory extends deeper those records are returned as well.
 
 .PP
 With etcd3, support for hierarchical keys are
 dropped
 \[la]https://coreos.com/etcd/docs/latest/learning/api.html\[ra]. This means there are no directories
-but only flat keys with prefixes in etcd3. To accommodate lookups, etcdv3 plugin now does a lookup
+but only flat keys with prefixes in etcd3. To accommodate lookups, the \fIetcd\fP plugin now does a lookup
 on prefix \fB\fC/skydns/test/skydns/mx/\fR to search for entries like \fB\fC/skydns/test/skydns/mx/a\fR etc, and
 if there is nothing found on \fB\fC/skydns/test/skydns/mx/\fR, it looks for \fB\fC/skydns/test/skydns/mx\fR to
 find entries like \fB\fC/skydns/test/skydns/mx1\fR.
 
 .PP
-This causes two lookups from CoreDNS to etcdv3 in certain cases.
+This causes two lookups from CoreDNS to etcd in certain cases.
 
 .SH "EXAMPLES"
 .PP
@@ -366,3 +366,7 @@ If you query the zone name for \fB\fCTXT\fR now, you will get the following resp
 .fi
 .RE
 
+.SH "ALSO SEE"
+.PP
+If you want to \fB\fCround robin\fR A and AAAA responses look at the \fIloadbalance\fP plugin.
+