coredns/plugin/federation/README.md
Miek Gieben 58221f55db
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.
2018-01-04 12:53:07 +00:00

50 lines
964 B
Markdown

# federation
## 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.
## 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.
~~~
. {
kubernetes cluster.local
federation cluster.local {
prod prod.feddomain.com
staging staging.feddomain.com
}
}
~~~
Or slightly shorter:
~~~
cluster.local {
kubernetes
federation {
prod prod.feddomain.com
staging staging.feddomain.com
}
}
~~~