aboutsummaryrefslogtreecommitdiff
path: root/plugin
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2017-09-15 09:56:05 +0100
committerGravatar GitHub <noreply@github.com> 2017-09-15 09:56:05 +0100
commitae9cae67e3b43a11b20c83bbef8f6c29b39467b6 (patch)
treefb4b241589efbf81d9503f01a88950c44272202e /plugin
parent74f9dc6c0046cf847e202f171663960f0f8a5d5a (diff)
downloadcoredns-ae9cae67e3b43a11b20c83bbef8f6c29b39467b6.tar.gz
coredns-ae9cae67e3b43a11b20c83bbef8f6c29b39467b6.tar.zst
coredns-ae9cae67e3b43a11b20c83bbef8f6c29b39467b6.zip
plugins: expand examples (#1077)
* plugins: expand examples Expand some examples and test them by annotating it with `corefile` * Can't start kubernetes * Can test pprof :(
Diffstat (limited to 'plugin')
-rw-r--r--plugin/auto/README.md20
-rw-r--r--plugin/bind/README.md6
-rw-r--r--plugin/cache/README.md8
-rw-r--r--plugin/debug/README.md6
-rw-r--r--plugin/erratic/README.md12
-rw-r--r--plugin/etcd/README.md14
-rw-r--r--plugin/federation/README.md6
-rw-r--r--plugin/metrics/README.md6
-rw-r--r--plugin/pprof/README.md4
-rw-r--r--plugin/root/README.md6
-rw-r--r--plugin/trace/README.md6
11 files changed, 56 insertions, 38 deletions
diff --git a/plugin/auto/README.md b/plugin/auto/README.md
index 7cbc4fced..e4c29c294 100644
--- a/plugin/auto/README.md
+++ b/plugin/auto/README.md
@@ -50,19 +50,23 @@ directive only is authoritative for `example.ORG`.
Load `org` domains from `/etc/coredns/zones/org` and allow transfers to the internet, but send
notifies to 10.240.1.1
-~~~
-auto org {
- directory /etc/coredns/zones/org
- transfer to *
- transfer to 10.240.1.1
+~~~ corefile
+. {
+ auto org {
+ directory /etc/coredns/zones/org
+ transfer to *
+ transfer to 10.240.1.1
+ }
}
~~~
Load `org` domains from `/etc/coredns/zones/org` and looks for file names as `www.db.example.org`,
where `example.org` is the origin. Scan every 45 seconds.
-~~~
-auto org {
- directory /etc/coredns/zones/org www\.db\.(.*) {1} 45
+~~~ corefile
+org {
+ auto {
+ directory /etc/coredns/zones/org www\.db\.(.*) {1} 45
+ }
}
~~~
diff --git a/plugin/bind/README.md b/plugin/bind/README.md
index 57b3c1e18..7b9ad6af6 100644
--- a/plugin/bind/README.md
+++ b/plugin/bind/README.md
@@ -17,6 +17,8 @@ bind ADDRESS
To make your socket accessible only to that machine, bind to IP 127.0.0.1 (localhost):
-~~~ txt
-bind 127.0.0.1
+~~~
+. {
+ bind 127.0.0.1
+}
~~~
diff --git a/plugin/cache/README.md b/plugin/cache/README.md
index 6477fe891..81cadcedb 100644
--- a/plugin/cache/README.md
+++ b/plugin/cache/README.md
@@ -62,7 +62,9 @@ cache 10
Proxy to Google Public DNS and only cache responses for example.org (or below).
-~~~
-proxy . 8.8.8.8:53
-cache example.org
+~~~ corefile
+. {
+ proxy . 8.8.8.8:53
+ cache example.org
+}
~~~
diff --git a/plugin/debug/README.md b/plugin/debug/README.md
index 2598a1900..47ee9b761 100644
--- a/plugin/debug/README.md
+++ b/plugin/debug/README.md
@@ -15,6 +15,8 @@ debug
Disable CoreDNS' ability to recover from crashes:
-~~~ txt
-debug
+~~~ corefile
+. {
+ debug
+}
~~~
diff --git a/plugin/erratic/README.md b/plugin/erratic/README.md
index a41faaca9..81074fa97 100644
--- a/plugin/erratic/README.md
+++ b/plugin/erratic/README.md
@@ -27,8 +27,8 @@ erratic {
## Examples
-~~~ txt
-.:53 {
+~~~ corefile
+. {
erratic {
drop 3
}
@@ -37,7 +37,7 @@ erratic {
Or even shorter if the defaults suits you. Note this only drops queries, it does not delay them.
-~~~ txt
+~~~ corefile
. {
erratic
}
@@ -45,7 +45,7 @@ Or even shorter if the defaults suits you. Note this only drops queries, it does
Delay 1 in 3 queries for 50ms
-~~~ txt
+~~~ corefile
. {
erratic {
delay 3 50ms
@@ -55,7 +55,7 @@ Delay 1 in 3 queries for 50ms
Delay 1 in 3 and truncate 1 in 5.
-~~~ txt
+~~~ corefile
. {
erratic {
delay 3 5ms
@@ -66,7 +66,7 @@ Delay 1 in 3 and truncate 1 in 5.
Drop every second query.
-~~~ txt
+~~~ corefile
. {
erratic {
drop 2
diff --git a/plugin/etcd/README.md b/plugin/etcd/README.md
index f65c193f1..383200771 100644
--- a/plugin/etcd/README.md
+++ b/plugin/etcd/README.md
@@ -50,8 +50,8 @@ etcd [ZONES...] {
This is the default SkyDNS setup, with everying specified in full:
-~~~
-.:53 {
+~~~ corefile
+. {
etcd skydns.local {
stubzones
path /skydns
@@ -68,8 +68,8 @@ This is the default SkyDNS setup, with everying specified in full:
Or a setup where we use `/etc/resolv.conf` as the basis for the proxy and the upstream
when resolving external pointing CNAMEs.
-~~~
-.:53 {
+~~~ corefile
+. {
etcd skydns.local {
path /skydns
upstream /etc/resolv.conf
@@ -88,9 +88,9 @@ need to add the zone `0.0.10.in-addr.arpa` to the list of zones. (The fun starts
in the ip6.arpa domain.) Showing a snippet of a Corefile:
~~~
- etcd skydns.local 0.0.10.in-addr.arpa {
- stubzones
- ...
+etcd skydns.local 0.0.10.in-addr.arpa {
+ stubzones
+...
~~~
Next you'll need to populate the zone with reverse records, here we add a reverse for
diff --git a/plugin/federation/README.md b/plugin/federation/README.md
index fb3d44e8c..63369e47a 100644
--- a/plugin/federation/README.md
+++ b/plugin/federation/README.md
@@ -20,9 +20,9 @@ federation [ZONES...] {
Here we handle all service requests in the `prod` and `stage` federations.
-~~~ txt
+~~~
. {
- kubernetes cluster.local
+ kubernetes cluster.local
federation cluster.local {
prod prod.feddomain.com
staging staging.feddomain.com
@@ -32,7 +32,7 @@ Here we handle all service requests in the `prod` and `stage` federations.
Or slightly shorter:
-~~~ txt
+~~~
cluster.local {
kubernetes
federation {
diff --git a/plugin/metrics/README.md b/plugin/metrics/README.md
index ead1f7e75..d3189586d 100644
--- a/plugin/metrics/README.md
+++ b/plugin/metrics/README.md
@@ -43,8 +43,10 @@ is `localhost:9153`. The metrics path is fixed to `/metrics`.
Use an alternative address:
-~~~
-prometheus localhost:9253
+~~~ corefile
+. {
+ prometheus localhost:9253
+}
~~~
# Bugs
diff --git a/plugin/pprof/README.md b/plugin/pprof/README.md
index 06a36e442..6dbac694c 100644
--- a/plugin/pprof/README.md
+++ b/plugin/pprof/README.md
@@ -31,7 +31,9 @@ pprof
Listen on an alternate address:
~~~
-pprof 10.9.8.7:6060
+. {
+ pprof 10.9.8.7:6060
+}
~~~
Listen on an all addresses on port 6060:
diff --git a/plugin/root/README.md b/plugin/root/README.md
index bd3fe33b3..0b73ce78b 100644
--- a/plugin/root/README.md
+++ b/plugin/root/README.md
@@ -17,6 +17,8 @@ root PATH
Serve zone data (when the *file* plugin is used) from `/etc/coredns/zones`:
-~~~ txt
-root /etc/coredns/zones
+~~~ corefile
+. {
+ root /etc/coredns/zones
+}
~~~
diff --git a/plugin/trace/README.md b/plugin/trace/README.md
index 62e6d463d..044b6fdcc 100644
--- a/plugin/trace/README.md
+++ b/plugin/trace/README.md
@@ -51,8 +51,10 @@ trace tracinghost:9253
or
-~~~
-trace zipkin tracinghost:9253
+~~~ corefile
+. {
+ trace zipkin tracinghost:9253
+}
~~~
If for some reason you are using an API reverse proxy or something and need to remap