Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
C
Coredns
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Railgun
Coredns
Commits
f33b0268
Commit
f33b0268
authored
Jul 24, 2017
by
Miek Gieben
Committed by
GitHub
Jul 24, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix all READMEs and some other fluff (#788)
parent
1e6f1347
Changes
13
Hide whitespace changes
Inline
Side-by-side
Showing
13 changed files
with
35 additions
and
32 deletions
+35
-32
Makefile.release
Makefile.release
+1
-1
middleware/bind/README.md
middleware/bind/README.md
+4
-3
middleware/chaos/README.md
middleware/chaos/README.md
+1
-0
middleware/debug/README.md
middleware/debug/README.md
+2
-2
middleware/erratic/README.md
middleware/erratic/README.md
+1
-5
middleware/errors/README.md
middleware/errors/README.md
+2
-1
middleware/hosts/README.md
middleware/hosts/README.md
+1
-1
middleware/loadbalance/README.md
middleware/loadbalance/README.md
+5
-5
middleware/metrics/README.md
middleware/metrics/README.md
+2
-2
middleware/pprof/README.md
middleware/pprof/README.md
+4
-3
middleware/proxy/README.md
middleware/proxy/README.md
+5
-4
middleware/rewrite/README.md
middleware/rewrite/README.md
+4
-3
middleware/root/README.md
middleware/root/README.md
+3
-2
No files found.
Makefile.release
View file @
f33b0268
...
@@ -31,7 +31,7 @@
...
@@ -31,7 +31,7 @@
# Steps for docker
# Steps for docker
# * Login into docker: docker login (should have push creds for coredns registry)
# * Login into docker: docker login (should have push creds for coredns registry)
# * Run: make -f Makefile.release docker
# * Run: make -f Makefile.release docker
#
#
# Docker push should happen after you make the new release and uploaded it to Github.
# Docker push should happen after you make the new release and uploaded it to Github.
NAME
:=
coredns
NAME
:=
coredns
...
...
middleware/bind/README.md
View file @
f33b0268
# bind
# bind
*bind*
overrides the host to which the server should bind. Normally, the listener binds to the
*bind*
overrides the host to which the server should bind.
wildcard host. However, you may force the listener to bind to another IP instead. This
directive accepts only an address, not a port.
Normally, the listener binds to the wildcard host. However, you may force the listener to bind to
another IP instead. This directive accepts only an address, not a port.
## Syntax
## Syntax
...
...
middleware/chaos/README.md
View file @
f33b0268
# chaos
# chaos
The
*chaos*
middleware allows CoreDNS to respond to TXT queries in the CH class.
The
*chaos*
middleware 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.
## Syntax
## Syntax
...
...
middleware/debug/README.md
View file @
f33b0268
# debug
# debug
*debug*
disables the automatic recovery upon a CoreDNS crash so that you'll get a
*debug*
disables the automatic recovery upon a CoreDNS crash so that you'll get a
nice stack trace.
nice stack trace.
Note that the
*errors*
middleware (if loaded) will also set a
`recover`
negating this setting.
Note that the
*errors*
middleware (if loaded) will also set a
`recover`
negating this setting.
The main use of
*debug*
is to help testing.
The main use of
*debug*
is to help testing.
...
...
middleware/erratic/README.md
View file @
f33b0268
# erratic
# erratic
*erratic*
is a middleware useful for testing client behavior. It returns a static response to all
*erratic*
is a middleware useful for testing client behavior. It returns a static response to all
queries, but the responses can be:
queries, but the responses can be delayed, dropped or truncated.
*
delayed by some duration
*
dropped all together
*
the truncated bit can be set
The
*erratic*
middleware will respond to every A or AAAA query. For any other type it will return
The
*erratic*
middleware 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
...
...
middleware/errors/README.md
View file @
f33b0268
# errors
# errors
*errors*
enables error logging.
*errors*
enables error logging.
TODO: what are errors.
Any errors encountered during the query processing will be printed on standard output.
## Syntax
## Syntax
...
...
middleware/hosts/README.md
View file @
f33b0268
# hosts
# hosts
*hosts*
enables serving zone data from a
/etc/hosts
style file.
*hosts*
enables serving zone data from a
`/etc/hosts`
style file.
The hosts middleware is useful for serving zones from a /etc/hosts file. It serves from a preloaded
The hosts middleware is useful for serving zones from a /etc/hosts file. It serves from a preloaded
file that exists on disk. It checks the file for changes and updates the zones accordingly. This
file that exists on disk. It checks the file for changes and updates the zones accordingly. This
...
...
middleware/loadbalance/README.md
View file @
f33b0268
# loadbalance
# loadbalance
*loadbalance*
acts as a round-robin DNS loadbalancer by randomizing the order of A and AAAA records
*loadbalance*
acts as a round-robin DNS loadbalancer by randomizing the order of A and AAAA records
in the answer.
See
[
Wikipedia
](
https://en.wikipedia.org/wiki/Round-robin_DNS
)
about the pros and
in the answer.
cons on this setup.
See
[
Wikipedia
](
https://en.wikipedia.org/wiki/Round-robin_DNS
)
about the pros and cons on this
It will take care to sort any CNAMEs before any address records, because some stub resolver
setup.
It will take care to sort any CNAMEs before any address records, because some stub resolver
implementations (like glibc) are particular about that.
implementations (like glibc) are particular about that.
## Syntax
## Syntax
...
...
middleware/metrics/README.md
View file @
f33b0268
# prometheus
# prometheus
This module enables prometheus metrics for CoreDNS. The default location for the metrics is
This module enables prometheus metrics for CoreDNS.
`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:
*
coredns_dns_request_count_total{zone, proto, family}
*
coredns_dns_request_count_total{zone, proto, family}
...
...
middleware/pprof/README.md
View file @
f33b0268
# pprof
# pprof
*pprof*
publishes runtime profiling data at endpoints under /debug/pprof. You can visit
*pprof*
publishes runtime profiling data at endpoints under /debug/pprof.
`/debug/pprof`
on your site for an index of the available endpoints. By default it will listen on localhost:6053.
You can visit
`/debug/pprof`
on your site for an index of the available endpoints. By default it
will listen on localhost:6053.
> This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If
> This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If
> you use pprof on a live site, consider restricting access or enabling it only temporarily.
> you use pprof on a live site, consider restricting access or enabling it only temporarily.
...
...
middleware/proxy/README.md
View file @
f33b0268
# proxy
# proxy
*proxy*
facilitates both a basic reverse proxy and a robust load balancer. The proxy has support for
*proxy*
facilitates both a basic reverse proxy and a robust load balancer.
multiple backends. The load balancing features include multiple policies, health checks, and
failovers. If all hosts fail their health check the proxy middleware will fail back to randomly
The proxy has support for multiple backends. The load balancing features include multiple policies,
selecting a target and sending packets to it.
health checks, and failovers. If all hosts fail their health check the proxy middleware will fail
back to randomly selecting a target and sending packets to it.
## Syntax
## Syntax
...
...
middleware/rewrite/README.md
View file @
f33b0268
# rewrite
# rewrite
*rewrite*
performs internal message rewriting. Rewrites are invisible to the client.
*rewrite*
performs internal message rewriting.
There are simple rewrites (fast) and complex rewrites (slower), but they're powerful enough to
accommodate most dynamic back-end applications.
Rewrites are invisible to the client. There are simple rewrites (fast) and complex rewrites
(slower), but they're powerful enough to accommodate most dynamic back-end applications.
## Syntax
## Syntax
...
...
middleware/root/README.md
View file @
f33b0268
# root
# root
*root*
simply specifies the root of where CoreDNS finds (e.g.) zone files.
*root*
simply specifies the root of where CoreDNS finds (e.g.) zone files.
The default root is the current working directory of CoreDNS.
A relative root path is relative to the current working directory.
The default root is the current working directory of CoreDNS. A relative root path is relative to
the current working directory.
## Syntax
## Syntax
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment