plugin/chaos/README.md

# chaos

The *chaos* plugin allows CoreDNS to respond to TXT queries in the CH class.

This is useful for retrieving version or author information from the server.

## Syntax

~~~
chaos [VERSION] [AUTHORS...]
~~~

* **VERSION** is the version to return. Defaults to `CoreDNS-<version>`, if not set.
* **AUTHORS** is what authors to return. No default.

Note that you have to make sure that this plugin will get actual queries for the
following zones: `version.bind`, `version.server`, `authors.bind`, `hostname.bind` and
`id.server`.

## Examples

Specify all the zones in full.

~~~ corefile
version.bind version.server authors.bind hostname.bind id.server {
    chaos CoreDNS-001 info@coredns.io
}
~~~

Or just default to `.`:

~~~ corefile
.  {
    chaos CoreDNS-001 info@coredns.io
}
~~~

And test with `dig`:

~~~ txt
% dig @localhost CH TXT version.bind
...
;; ANSWER SECTION:
version.bind.		0	CH	TXT	"CoreDNS-001"
...
~~~
Implement chaos middleware This allows for CH TXT queries that return some information about the server and/or the authors (or whatever you put in there). 2016-03-24 17:58:31 +00:00			`# chaos`

Remove the word middleware (#1067) * Rename middleware to plugin first pass; mostly used 'sed', few spots where I manually changed text. This still builds a coredns binary. * fmt error * Rename AddMiddleware to AddPlugin * Readd AddMiddleware to remain backwards compat 2017-09-14 09:36:06 +01:00			`The chaos plugin allows CoreDNS to respond to TXT queries in the CH class.`
Fix all READMEs and some other fluff (#788) 2017-07-24 08:24:53 -07:00
Update README.md Grammatical fixes. 2016-08-22 13:53:00 -07:00			`This is useful for retrieving version or author information from the server.`
Implement chaos middleware This allows for CH TXT queries that return some information about the server and/or the authors (or whatever you put in there). 2016-03-24 17:58:31 +00:00
			`## Syntax`

			`~~~`
docs: rewrite using manpage style (#327) This still needs cleanup, but this is a first pass the cleans some cruft and documents our style (in middleware.md) and makes all the docs match that style. 2016-10-10 20:13:22 +01:00			`chaos [VERSION] [AUTHORS...]`
Implement chaos middleware This allows for CH TXT queries that return some information about the server and/or the authors (or whatever you put in there). 2016-03-24 17:58:31 +00:00			`~~~`

ServiceBackend interface (#369) * Add ServiceBackend interface This adds a ServiceBackend interface that is shared between etcd/etcd3 (later) and kubernetes, leading to a massive reduction in code. When returning the specific records from their backend. Fixes #273 2016-10-30 15:54:16 +00:00			* VERSION is the version to return. Defaults to `CoreDNS-<version>`, if not set.
			`* AUTHORS is what authors to return. No default.`
Implement chaos middleware This allows for CH TXT queries that return some information about the server and/or the authors (or whatever you put in there). 2016-03-24 17:58:31 +00:00
Remove the word middleware (#1067) * Rename middleware to plugin first pass; mostly used 'sed', few spots where I manually changed text. This still builds a coredns binary. * fmt error * Rename AddMiddleware to AddPlugin * Readd AddMiddleware to remain backwards compat 2017-09-14 09:36:06 +01:00			`Note that you have to make sure that this plugin will get actual queries for the`
Fix stubzone retention (#198) Make the receiver a pointer so that the uptdateStubZones map update will retain the stubzones found, unlike the current case where the update will be applied and then promptly forgotten, because it is working on a copy. Add test/etcd_test.go to test a large part of the code. This didn't catch the chaos middleware hack though. The chaos middleware zones are now not automatically added. You have to take care of that by yourself (docs updates). When using debug queries and falling through to the next middleware in etcd, restore the original (with o-o.debug) query before passing it on. 2016-08-08 19:18:55 -07:00			following zones: `version.bind`, `version.server`, `authors.bind`, `hostname.bind` and
			`id.server`.
Cleanup docs and the chaos middleware Make the CH middleware actually work. Needs a bit of a hack to route the fake version.bind and friends zone to the correct handler. Fiddle with the order in directive.go so that CH queries get logged as well. Secondly add class rewriting to the rewrite middleware handler and also log the class by default. 2016-04-04 15:45:17 +01:00
Implement chaos middleware This allows for CH TXT queries that return some information about the server and/or the authors (or whatever you put in there). 2016-03-24 17:58:31 +00:00			`## Examples`

mw/chaos: update docs (#1055) * mw/chaos: update docs Fix/update the documentation: make the corefile snippets tested and expand them a little. Show `dig` example. Fixes #1050 * dot 2017-09-10 21:01:49 +01:00			`Specify all the zones in full.`

			`~~~ corefile`
			`version.bind version.server authors.bind hostname.bind id.server {`
			`chaos CoreDNS-001 info@coredns.io`
			`}`
			`~~~`

			Or just default to `.`:

			`~~~ corefile`
			`. {`
			`chaos CoreDNS-001 info@coredns.io`
			`}`
Implement chaos middleware This allows for CH TXT queries that return some information about the server and/or the authors (or whatever you put in there). 2016-03-24 17:58:31 +00:00			`~~~`
mw/chaos: update docs (#1055) * mw/chaos: update docs Fix/update the documentation: make the corefile snippets tested and expand them a little. Show `dig` example. Fixes #1050 * dot 2017-09-10 21:01:49 +01:00
			And test with `dig`:

			`~~~ txt`
			`% dig @localhost CH TXT version.bind`
			`...`
			`;; ANSWER SECTION:`
			`version.bind. 0 CH TXT "CoreDNS-001"`
			`...`
Implement chaos middleware This allows for CH TXT queries that return some information about the server and/or the authors (or whatever you put in there). 2016-03-24 17:58:31 +00:00			`~~~`