Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-11-01 10:43:17 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: rewrite using manpage style (#327)

Browse Source 
This still needs cleanup, but this is a first pass the cleans some
cruft and documents our style (in middleware.md) and makes all the
docs match that style.
This commit is contained in:
Miek Gieben
2016-10-10 20:13:22 +01:00
committed by GitHub
parent c22b7b2252
commit faf83b00dd
18 changed files with 154 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
middleware/etcd/README.md
View File

@@ -1,6 +1,6 @@
# etcd
`etcd` enables reading zone data from an etcd instance. The data in etcd has to be encoded as
*etcd* enables reading zone data from an etcd instance. The data in etcd has to be encoded as
a [message](https://github.com/skynetservices/skydns/blob/2fcff74cdc9f9a7dd64189a447ef27ac354b725f/msg/service.go#L26)
like [SkyDNS](https//github.com/skynetservices/skydns). It should also work just like SkyDNS.
@@ -10,10 +10,10 @@ in the network.
## Syntax
~~~
etcd [zones...]
etcd [ZONES...]
~~~
* `zones` zones etcd should be authoritative for.
* **ZONES** zones etcd should be authoritative for.
The path will default to `/skydns` the local etcd proxy (http://localhost:2379).
If no zones are specified the block's zone will be used as the zone.
@@ -21,20 +21,20 @@ If no zones are specified the block's zone will be used as the zone.
If you want to `round robin` A and AAAA responses look at the `loadbalance` middleware.
~~~
etcd [zones...] {
etcd [ZONES...] {
stubzones
path /skydns
endpoint endpoint...
upstream address...
tls cert key cacert
path PATH
endpoint ENDPOINT...
upstream ADDRESS...
tls CERT KEY CACERt
debug
}
~~~
* `stubzones` enables the stub zones feature. The stubzone is *only* done in the etcd tree located
under the *first* zone specified.
* `path` the path inside etcd. Defaults to "/skydns".
* `endpoint` the etcd endpoints. Defaults to "http://localhost:2397".
* **PATH** the path inside etcd. Defaults to "/skydns".
* **ENDPOINT** the etcd endpoints. Defaults to "http://localhost:2397".
* `upstream` upstream resolvers to be used resolve external names found in etcd (think CNAMEs)
pointing to external names. If you want CoreDNS to act as a proxy for clients, you'll need to add
the proxy middleware.
@@ -129,4 +129,3 @@ Any errors seen doing parsing will show up like this:
. 0 CH TXT "/skydns/local/skydns/r/a: invalid character '.' after object key:value pair"
which shows `a.r.skydns.local.` has a json encoding problem.