diff options
Diffstat (limited to 'plugin/autopath/README.md')
-rw-r--r-- | plugin/autopath/README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/plugin/autopath/README.md b/plugin/autopath/README.md new file mode 100644 index 000000000..02b4390fc --- /dev/null +++ b/plugin/autopath/README.md @@ -0,0 +1,45 @@ +# autopath + +The *autopath* plugin allows CoreDNS to perform server side search path completion. +If it sees a query that matches the first element of the configured search path, *autopath* will +follow the chain of search path elements and returns the first reply that is not NXDOMAIN. +On any failures the original reply is returned. + +Because *autopath* 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. + +## Syntax + +~~~ +autopath [ZONE..] RESOLV-CONF +~~~ + +* **ZONES** zones *autopath* should be authoritative for. +* **RESOLV-CONF** points to a `resolv.conf` like file or uses a special syntax to point to another + plugin. For instance `@kubernetes`, will call out to the kubernetes plugin (for each + query) to retrieve the search list it should use. + +Currently the following set of plugin has implemented *autopath*: + +* *kubernetes* +* *erratic* + +## Examples + +~~~ +autopath my-resolv.conf +~~~ + +Use `my-resolv.conf` as the file to get the search path from. This file only needs so have one line: +`search domain1 domain2 ...` + +~~~ +autopath @kubernetes +~~~ + +Use the search path dynamically retrieved from the kubernetes plugin. + +## Bugs + +When the *cache* plugin is enabled it is possible for pods in different namespaces to get the +same answer. |