aboutsummaryrefslogtreecommitdiff
path: root/plugin
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2018-07-06 11:27:40 +0100
committerGravatar GitHub <noreply@github.com> 2018-07-06 11:27:40 +0100
commitbcc749db04253e12dd3cce3f6a29700a6a74168f (patch)
treee5f679c04e62a1c56311004747be7f082d6500db /plugin
parent195fe5d1a45559fa3a712b8be3a097eb70550b3e (diff)
downloadcoredns-bcc749db04253e12dd3cce3f6a29700a6a74168f.tar.gz
coredns-bcc749db04253e12dd3cce3f6a29700a6a74168f.tar.zst
coredns-bcc749db04253e12dd3cce3f6a29700a6a74168f.zip
Docs (#1943)
* Doc updates Make the name section fit on one line. Signed-off-by: Miek Gieben <miek@miek.nl> * Regen docs Signed-off-by: Miek Gieben <miek@miek.nl>
Diffstat (limited to 'plugin')
-rw-r--r--plugin/dnstap/README.md2
-rw-r--r--plugin/loadbalance/README.md16
-rw-r--r--plugin/reload/README.md2
3 files changed, 11 insertions, 9 deletions
diff --git a/plugin/dnstap/README.md b/plugin/dnstap/README.md
index 2f8ea7664..81152e742 100644
--- a/plugin/dnstap/README.md
+++ b/plugin/dnstap/README.md
@@ -2,7 +2,7 @@
## Name
-*dnstap* - enable logging to dnstap
+*dnstap* - enable logging to dnstap.
## Description
diff --git a/plugin/loadbalance/README.md b/plugin/loadbalance/README.md
index 58a7956e0..4c075bb9d 100644
--- a/plugin/loadbalance/README.md
+++ b/plugin/loadbalance/README.md
@@ -2,14 +2,16 @@
## Name
-*loadbalance* - acts as a round-robin DNS loadbalancer by randomizing the order of A and AAAA records
- in the answer.
+*loadbalance* - randomize the order of A and AAAA records.
## Description
+
+The *loadbalance* will act as a round-robin DNS loadbalancer by randomizing the order of A and AAAA
+records in the answer.
- See [Wikipedia](https://en.wikipedia.org/wiki/Round-robin_DNS) about the pros and cons on this
- setup. It will take care to sort any CNAMEs before any address records, because some stub resolver
- implementations (like glibc) are particular about that.
+See [Wikipedia](https://en.wikipedia.org/wiki/Round-robin_DNS) about the pros and cons on this
+setup. It will take care to sort any CNAMEs before any address records, because some stub resolver
+implementations (like glibc) are particular about that.
## Syntax
@@ -17,7 +19,7 @@
loadbalance [POLICY]
~~~
-* **POLICY** is how to balance, the default is "round_robin"
+* **POLICY** is how to balance, the default, and only option, is "round_robin".
## Examples
@@ -26,6 +28,6 @@ Load balance replies coming back from Google Public DNS:
~~~ corefile
. {
loadbalance round_robin
- proxy . 8.8.8.8 8.8.4.4
+ forward . 8.8.8.8 8.8.4.4
}
~~~
diff --git a/plugin/reload/README.md b/plugin/reload/README.md
index 4c98b7a7f..eb06bb71c 100644
--- a/plugin/reload/README.md
+++ b/plugin/reload/README.md
@@ -2,7 +2,7 @@
## Name
-*reload* - allows automatic reload of a changed Corefile
+*reload* - allows automatic reload of a changed Corefile.
## Description