aboutsummaryrefslogtreecommitdiff
path: root/plugin/federation/README.md
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2018-01-04 12:53:07 +0000
committerGravatar GitHub <noreply@github.com> 2018-01-04 12:53:07 +0000
commit58221f55db5675c6107d19679c46a216ed072aca (patch)
treef4f86c8ecd35538da492524dec549566daf40809 /plugin/federation/README.md
parent0600f8c058f39c7afec9f915657e06f158d21c47 (diff)
downloadcoredns-58221f55db5675c6107d19679c46a216ed072aca.tar.gz
coredns-58221f55db5675c6107d19679c46a216ed072aca.tar.zst
coredns-58221f55db5675c6107d19679c46a216ed072aca.zip
Manual pages (#1346)
* Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
Diffstat (limited to 'plugin/federation/README.md')
-rw-r--r--plugin/federation/README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/plugin/federation/README.md b/plugin/federation/README.md
index 54aa3f824..021921cb2 100644
--- a/plugin/federation/README.md
+++ b/plugin/federation/README.md
@@ -1,7 +1,13 @@
# federation
-*federation* enables
-[federated](https://kubernetes.io/docs/tasks/federation/federation-service-discovery/) queries to be
+## Name
+
+*federation* - enables federated queries to be resolved via the kubernetes plugin.
+
+## Description
+
+Enabling this plugin allows
+[Federated](https://kubernetes.io/docs/tasks/federation/federation-service-discovery/) queries to be
resolved via the kubernetes plugin.
Enabling *federation* without also having *kubernetes* is a noop.
@@ -11,6 +17,7 @@ Enabling *federation* without also having *kubernetes* is a noop.
~~~
federation [ZONES...] {
NAME DOMAIN
+}
~~~
* Each **NAME** and **DOMAIN** defines federation membership. One entry for each. A duplicate