mirror of
https://github.com/coredns/coredns.git
synced 2026-01-07 17:31:23 -05:00
doc: make -f Makefile.doc (#2919)
mechanical change: create the manual pages. Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
@@ -1,11 +1,11 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-CACHE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-CACHE" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH NAME
|
||||
.SH "NAME"
|
||||
.PP
|
||||
\fIcache\fP - enables a frontend cache.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
With \fIcache\fP enabled, all records except zone transfers and metadata records will be cached for up to
|
||||
3600s. Caching is mostly useful in a scenario when fetching data from the backend (upstream,
|
||||
@@ -14,7 +14,7 @@ database, etc.) is expensive.
|
||||
.PP
|
||||
This plugin can only be used once per Server Block.
|
||||
|
||||
.SH SYNTAX
|
||||
.SH "SYNTAX"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -72,7 +72,7 @@ which defaults to \fB\fC10%\fR, or latest 1 second before TTL expiration. Values
|
||||
Note the percent sign is mandatory. \fBPERCENTAGE\fP is treated as an \fB\fCint\fR.
|
||||
|
||||
|
||||
.SH CAPACITY AND EVICTION
|
||||
.SH "CAPACITY AND EVICTION"
|
||||
.PP
|
||||
If \fBCAPACITY\fP \fIis not\fP specified, the default cache size is 9984 per cache. The minimum allowed cache size is 1024.
|
||||
If \fBCAPACITY\fP \fIis\fP specified, the actual cache size used will be rounded down to the nearest number divisible by 256 (so all shards are equal in size).
|
||||
@@ -83,7 +83,7 @@ Since shards don't fill up perfectly evenly, evictions will occur before the ent
|
||||
Each shard capacity is equal to the total cache size / number of shards (256). Eviction is random, not TTL based.
|
||||
Entries with 0 TTL will remain in the cache until randomly evicted when the shard reaches capacity.
|
||||
|
||||
.SH METRICS
|
||||
.SH "METRICS"
|
||||
.PP
|
||||
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported:
|
||||
|
||||
@@ -101,7 +101,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following
|
||||
Cache types are either "denial" or "success". \fB\fCServer\fR is the server handling the request, see the
|
||||
metrics plugin for documentation.
|
||||
|
||||
.SH EXAMPLES
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
Enable caching for all zones, but cap everything to a TTL of 10 seconds:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user