Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-27 08:14:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc: run make -f Makefile.doc (#3314)

Browse Source 
add the acl manual page; mechanical change otherwise.

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2019-09-27 13:30:22 +01:00
committed by GitHub
parent 7328d3e8c9
commit 4568a3c25a
39 changed files with 259 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
man/coredns-metadata.7
View File

@@ -1,31 +1,31 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-METADATA" 7 "August 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-METADATA" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
\fImetadata\fP - enable a meta data collector.
\fImetadata\fP - enables a metadata collector.
.SH "DESCRIPTION"
.PP
By enabling \fImetadata\fP any plugin that implements metadata.Provider
interface
\[la]https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider\[ra] will be called for
each DNS query, at beginning of the process for that query, in order to add its own meta data to
each DNS query, at the beginning of the process for that query, in order to add its own metadata to
context.
.PP
The meta data collected will be available for all plugins, via the Context parameter provided in the
The metadata collected will be available for all plugins, via the Context parameter provided in the
ServeDNS function. The package (code) documentation has examples on how to inspect and retrieve
metadata a plugin might be interested in.
.PP
The meta data is added by setting a label with a value in the context. These labels should be named
The metadata is added by setting a label with a value in the context. These labels should be named
\fB\fCplugin/NAME\fR, where \fBNAME\fP is something descriptive. The only hard requirement the \fImetadata\fP
plugin enforces is that the labels contains a slash. See the documentation for
plugin enforces is that the labels contain a slash. See the documentation for
\fB\fCmetadata.SetValueFunc\fR.
.PP
The value stored is a string. The empty string signals "no meta data". See the documentation for
The value stored is a string. The empty string signals "no metadata". See the documentation for
\fB\fCmetadata.ValueFunc\fR on how to retrieve this.
.SH "SYNTAX"