COREDNS-AUTOPATH(7)

πŸ“¦
version 1.15.0 Β· 2 versions
, in nixpkgs unstable, opensuse-leap 16.0

πŸ¦‹ COREDNS-AUTOPATH(7) β€” the autopath glow-up from the CoreDNS Plugins manual ✨

🌸 NAME 🌸

autopath β€” allows for server-side search path completion. Periodt, that's the whole vibe: it does the search-path work on the server side for you πŸ’….

✨ DESCRIPTION ✨

Okay so bestie, here's how autopath moves. If the autopath 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. No cap.

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. It's giving "I found your answer, but let me introduce it properly" energy 🌈.

Heads up: there are several known issues β€” see the BUGS section below, iykyk 😭.

πŸ› οΈ SYNTAX πŸ› οΈ

autopath [ZONE...] RESOLV-CONF
  • ZONES β€” zones autopath should be authoritative for. In the synopsis this is the [ZONE...] part, bestie.
  • 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. Obsessed with a dynamic search list? This is that πŸ¦‹.

If a plugin implements the AutoPather interface then it can be used by autopath.

πŸ“Š METRICS πŸ“Š

If monitoring is enabled (via the prometheus plugin) then the following metric is exported:

  • coredns_autopath_success_total{server} β€” counter of successfully autopath-ed queries.

The server label is explained in the metrics plugin documentation. Slay, observability πŸ’–.

πŸŽ€ EXAMPLES πŸŽ€

autopath my-resolv.conf

Use my-resolv.conf as the file to get the search path from. This file only needs to have one line: search domain1 domain2 .... Literally one line, no extra drama πŸ“.

autopath @kubernetes

Use the search path dynamically retrieved from the kubernetes plugin. Main character energy: the search path comes straight from the cluster 🌈.

πŸ’€ BUGS πŸ’€

Okay bestie, this is the part where we keep it real, because autopath has some known issues:

  • In Kubernetes, autopath 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, autopath needs to know the namespace of the Pod making a DNS request. To do this, it relies on the kubernetes 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 its IP is immediately provisioned to a Pod in another namespace, and that new Pod make a DNS lookup before the API watch can notify CoreDNS of the change, autopath will resolve the IP to the previous Pod's namespace. 😭
  • In Kubernetes, autopath is not compatible with Pods running from Windows nodes. Not the vibe on Windows nodes, fr fr πŸ™ˆ.
  • If the server side search ultimately results in a negative answer (e.g. NXDOMAIN), then the client will fruitlessly search all paths manually, thus negating the autopath optimization. Big yikes: that undoes the whole point πŸ’€.

πŸ’– Cute little sign-off: this page comes from CoreDNS, the manual name is COREDNS-AUTOPATH(7), and the date on it is March 2026. Byeee, go slay your search path 🫢✨

πŸ“¦ where this page comes from