aboutsummaryrefslogtreecommitdiff
path: root/plugin.md
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2017-10-31 13:33:41 +0000
committerGravatar John Belamaric <jbelamaric@infoblox.com> 2017-10-31 09:33:41 -0400
commitfa2ae3fb4321052326a906da91df8ce8e80ae5a4 (patch)
tree8e1581908256f2f667fdd8d704b8e7374c624c92 /plugin.md
parent1d4ac4adbbfa7f2f4d3549e3e77056f2503d8f8e (diff)
downloadcoredns-fa2ae3fb4321052326a906da91df8ce8e80ae5a4.tar.gz
coredns-fa2ae3fb4321052326a906da91df8ce8e80ae5a4.tar.zst
coredns-fa2ae3fb4321052326a906da91df8ce8e80ae5a4.zip
docs: updates some, remove others (#1187)
Fix typo in kubernetes/README.md and remove DEV-README.md as it is stale and information on the website is more up to date. Remove large sections of text in plugin.md; just talk about how to structure your plugin and docs.
Diffstat (limited to 'plugin.md')
-rw-r--r--plugin.md86
1 files changed, 10 insertions, 76 deletions
diff --git a/plugin.md b/plugin.md
index da5167270..ee23f26c1 100644
--- a/plugin.md
+++ b/plugin.md
@@ -2,35 +2,6 @@
## Writing Plugins
-From the Caddy docs:
-
-> Oh yes, those pesky return values on ServeHTTP(). You read the documentation so you already know
-> what they mean. But what does that imply for the behavior of your plugin?
->
-> Basically, return a status code only if you did NOT write to the response body. If you DO write to
-> the response body, return a status code of 0. Return an error value if your plugin encountered
-> an error that you want logged. It is common to return an error status and an error value together,
-> so that the error handler up the chain can write the correct error page.
->
-> The returned status code is not logged directly; rather, it tells plugin higher up the chain
-> what status code to use if/when the response body is written. Again, return a 0 status if you've
-> already written a body!
-
-In the DNS status codes are called rcodes and it's slightly harder to return the correct
-answer in case of failure.
-
-So CoreDNS treats:
-
-* SERVFAIL (dns.RcodeServerFailure)
-* REFUSED (dns.RcodeRefused)
-* FORMERR (dns.RcodeFormatError)
-* NOTIMP (dns.RcodeNotImplemented)
-
-as special and will then assume nothing has written to the client. In all other cases it is assumes
-something has been written to the client (by the plugin).
-
-## Hooking It Up
-
See a couple of blog posts on how to write and add plugin to CoreDNS:
* <https://blog.coredns.io/2017/03/01/how-to-add-plugin-to-coredns/>
@@ -39,14 +10,14 @@ See a couple of blog posts on how to write and add plugin to CoreDNS:
## Metrics
When exporting metrics the *Namespace* should be `plugin.Namespace` (="coredns"), and the
-*Subsystem* should be the name of the plugin. The README.md for the plugin should then
-also contain a *Metrics* section detailing the metrics. If the plugin supports dynamic health
-reporting it should also have *Health* section detailing on its inner workings.
+*Subsystem* should be the name of the plugin. The README.md for the plugin should then also contain
+ a *Metrics* section detailing the metrics. If the plugin supports dynamic health reporting it
+ should also have *Health* section detailing on some of its inner workings.
## Documentation
-Each plugin should have a README.md explaining what the plugin does and how it is
-configured. The file should have the following layout:
+Each plugin should have a README.md explaining what the plugin does and how it is configured. The
+file should have the following layout:
* Title: use the plugin's name
* Subsection titled: "Syntax"
@@ -72,16 +43,17 @@ standard domain names created for this purpose.
## Fallthrough
-In a perfect world the following would be true for plugin: "Either you are responsible for
-a zone or not". If the answer is "not", the plugin should call the next plugin in the chain.
-If "yes" it should handle *all* names that fall in this zone and the names below - i.e. it should
-handle the entire domain.
+In a perfect world the following would be true for plugin: "Either you are responsible for a zone or
+not". If the answer is "not", the plugin should call the next plugin in the chain. If "yes" it
+should handle *all* names that fall in this zone and the names below - i.e. it should handle the
+entire domain.
~~~ txt
. {
file example.org db.example
}
~~~
+
In this example the *file* plugin is handling all names below (and including) `example.org`. If
a query comes in that is not a subdomain (or equal to) `example.org` the next plugin is called.
@@ -96,44 +68,6 @@ reverse cases and **all other** request are handled by the backing plugin. This
"fallthrough" does. To keep things explicit we've opted that plugins implement such behavior
should implement a `fallthrough` keyword.
-### Example Fallthrough Usage
-
-The following Corefile example, sets up the *reverse* plugin, but disables fallthrough. It
-also defines a zonefile for use with the *file* plugin for other names in the `compute.internal`.
-
-~~~ txt
-arpa compute.internal {
- reverse 10.32.0.0/16 {
- hostname ip-{ip}.{zone[2]}
- #fallthrough
- }
- file db.compute.internal compute.internal
-}
-~~~
-
-This works for returning a response to a PTR request:
-
-~~~ sh
-% dig +nocmd @localhost +noall +ans -x 10.32.0.1
-1.0.32.10.in-addr.arpa. 3600 IN PTR ip-10-32-0-1.compute.internal.
-~~~
-
-And for the forward:
-
-~~~ sh
-% dig +nocmd @localhost +noall +ans A ip-10-32-0-1.compute.internal
-ip-10-32-0-1.compute.internal. 3600 IN A 10.32.0.1
-~~~
-
-But a query for `mx compute.internal` will return SERVFAIL. Now when we remove the '#' from
-fallthrough and reload (on Unix: `kill -SIGUSR1 $(pidof coredns)`) CoreDNS, we *should* get an
-answer for the MX query:
-
-~~~ sh
-% dig +nocmd @localhost +noall +ans MX compute.internal
-compute.internal. 3600 IN MX 10 mx.compute.internal.
-~~~
-
## Qualifying for main repo
Plugins for CoreDNS can live out-of-tree, `plugin.cfg` defaults to CoreDNS' repo but other