aboutsummaryrefslogtreecommitdiff
path: root/plugin/federation/README.md
diff options
context:
space:
mode:
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