plugin: README.md updates (#1084)

updates so the look better on coredns.io
This commit is contained in:
Miek Gieben 2017-09-15 22:27:55 +01:00 committed by GitHub
parent 19d7d207d3
commit 2388e36c2c
10 changed files with 21 additions and 21 deletions

View file

@ -1,12 +1,12 @@
# autopath # autopath
The *autopath* plugin allows CoreDNS to perform server side search path completion. *autopath* allows CoreDNS to perform server side search path completion.
If it sees a query that matches the first element of the configured search path, *autopath* will
follow the chain of search path elements and returns the first reply that is not NXDOMAIN.
On any failures the original reply is returned.
Because *autopath* returns a reply for a name that wasn't the original question it will add a CNAME If it sees a query that matches the first element of the configured search path, *autopath* will
that points from the original name (with the search path element in it) to the name of this answer. follow the chain of search path elements and returns the first reply that is not NXDOMAIN. On any
failures the original reply is returned. Because *autopath* returns a reply for a name that wasn't
the original question it will add a CNAME that points from the original name (with the search path
element in it) to the name of this answer.
## Syntax ## Syntax

View file

@ -1,6 +1,6 @@
# chaos # chaos
The *chaos* plugin allows CoreDNS to respond to TXT queries in the CH class. *chaos* allows CoreDNS to respond to TXT queries in the CH class.
This is useful for retrieving version or author information from the server. This is useful for retrieving version or author information from the server.

View file

@ -1,14 +1,14 @@
# erratic # erratic
*erratic* is a plugin useful for testing client behavior. It returns a static response to all *erratic* is a plugin useful for testing client behavior.
queries, but the responses can be delayed, dropped or truncated.
It returns a static response to all queries, but the responses can be delayed, dropped or truncated.
The *erratic* plugin will respond to every A or AAAA query. For any other type it will return The *erratic* plugin will respond to every A or AAAA query. For any other type it will return
a SERVFAIL response. The reply for A will return 192.0.2.53 (see RFC 5737), for AAAA it returns a SERVFAIL response. The reply for A will return 192.0.2.53 (see RFC 5737), for AAAA it returns
2001:DB8::53 (see RFC 3849). 2001:DB8::53 (see RFC 3849).
*erratic* can also be used in conjunction with the *autopath* plugin. This is mostly to aid in *erratic* can also be used in conjunction with the *autopath* plugin. This is mostly to aid in
testing. testing.
## Syntax ## Syntax

View file

@ -1,6 +1,6 @@
# federation # federation
The *federation* plugin enables *federation* enables
[federated](https://kubernetes.io/docs/tasks/federation/federation-service-discovery/) queries to be [federated](https://kubernetes.io/docs/tasks/federation/federation-service-discovery/) queries to be
resolved via the kubernetes plugin. resolved via the kubernetes plugin.

View file

@ -1,6 +1,6 @@
# health # health
This module enables a simple health check endpoint. By default it will listen on port 8080. *health* enabless a simple health check endpoint. By default it will listen on port 8080.
## Syntax ## Syntax

View file

@ -1,7 +1,8 @@
# kubernetes # kubernetes
The *kubernetes* plugin enables the reading zone data from a Kubernetes cluster. It implements The *kubernetes* plugin enables the reading zone data from a Kubernetes cluster.
the [Kubernetes DNS-Based Service Discovery
It implements the [Kubernetes DNS-Based Service Discovery
Specification](https://github.com/kubernetes/dns/blob/master/docs/specification.md). Specification](https://github.com/kubernetes/dns/blob/master/docs/specification.md).
CoreDNS running the kubernetes plugin can be used as a replacement of kube-dns in a kubernetes CoreDNS running the kubernetes plugin can be used as a replacement of kube-dns in a kubernetes

View file

@ -1,6 +1,6 @@
# prometheus # prometheus
This module enables prometheus metrics for CoreDNS. *prometheus* enables [Prometheus](https://prometheus.io/) metrics for CoreDNS.
The default location for the metrics is `localhost:9153`. The metrics path is fixed to `/metrics`. The default location for the metrics is `localhost:9153`. The metrics path is fixed to `/metrics`.
The following metrics are exported: The following metrics are exported:

View file

@ -1,6 +1,6 @@
# pprof # pprof
*pprof* publishes runtime profiling data at endpoints under /debug/pprof. *pprof* publishes runtime profiling data at endpoints under `/debug/pprof`.
You can visit `/debug/pprof` on your site for an index of the available endpoints. By default it You can visit `/debug/pprof` on your site for an index of the available endpoints. By default it
will listen on localhost:6053. will listen on localhost:6053.

View file

@ -1,6 +1,6 @@
# reverse # reverse
The *reverse* plugin allows CoreDNS to respond dynamically to a PTR request and the related A/AAAA request. *reverse* allows CoreDNS to respond dynamically to a PTR request and the related A/AAAA request.
## Syntax ## Syntax
@ -38,7 +38,7 @@ The zone will be matched by the zones listed in *this* configuration stanza.
## Examples ## Examples
~~~ txt ~~~ corefile
arpa compute.internal { arpa compute.internal {
# proxy unmatched requests # proxy unmatched requests
proxy . 8.8.8.8 proxy . 8.8.8.8
@ -63,7 +63,7 @@ arpa compute.internal {
~~~ ~~~
~~~ txt ~~~ corefile
32.10.in-addr.arpa.arpa arpa.company.org { 32.10.in-addr.arpa.arpa arpa.company.org {
reverse 10.32.0.0/16 { reverse 10.32.0.0/16 {

View file

@ -1,7 +1,6 @@
# trace # trace
This module enables OpenTracing-based tracing of DNS requests as they go through the *trace* enables OpenTracing-based tracing of DNS requests as they go through the plugin chain.
plugin chain.
## Syntax ## Syntax