aboutsummaryrefslogtreecommitdiff
path: root/plugin/federation/README.md
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2017-09-14 09:36:06 +0100
committerGravatar GitHub <noreply@github.com> 2017-09-14 09:36:06 +0100
commitd8714e64e400ef873c2adc4d929a07d7890727b9 (patch)
treec9fa4c157e6af12eb1517654f8d23ca5d5619513 /plugin/federation/README.md
parentb984aa45595dc95253b91191afe7d3ee29e71b48 (diff)
downloadcoredns-d8714e64e400ef873c2adc4d929a07d7890727b9.tar.gz
coredns-d8714e64e400ef873c2adc4d929a07d7890727b9.tar.zst
coredns-d8714e64e400ef873c2adc4d929a07d7890727b9.zip
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
Diffstat (limited to 'plugin/federation/README.md')
-rw-r--r--plugin/federation/README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/plugin/federation/README.md b/plugin/federation/README.md
new file mode 100644
index 000000000..fb3d44e8c
--- /dev/null
+++ b/plugin/federation/README.md
@@ -0,0 +1,43 @@
+# federation
+
+The *federation* plugin enables
+[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.
+
+## Syntax
+
+~~~
+federation [ZONES...] {
+ NAME DOMAIN
+~~~
+
+* Each **NAME** and **DOMAIN** defines federation membership. One entry for each. A duplicate
+ **NAME** will silently overwrite any previous value.
+
+## Examples
+
+Here we handle all service requests in the `prod` and `stage` federations.
+
+~~~ txt
+. {
+ kubernetes cluster.local
+ federation cluster.local {
+ prod prod.feddomain.com
+ staging staging.feddomain.com
+ }
+}
+~~~
+
+Or slightly shorter:
+
+~~~ txt
+cluster.local {
+ kubernetes
+ federation {
+ prod prod.feddomain.com
+ staging staging.feddomain.com
+ }
+}
+~~~