Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-12-08 11:25:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Regenerate man page (#3946)

Browse Source 
Regenerate man page `make -f Makefile.doc`, in praparation for 1.7.0
release.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
This commit is contained in:
Yong Tang
2020-06-13 07:41:05 -07:00
committed by GitHub
parent 4734c0db45
commit 9545346174
45 changed files with 77 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
man/coredns-kubernetes.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-KUBERNETES" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-KUBERNETES" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@@ -241,7 +241,8 @@ upstreamNameservers: |
.PP
The \fIkubernetes\fP plugin can be used in conjunction with the \fIautopath\fP plugin. Using this
feature enables server-side domain search path completion in Kubernetes clusters. Note: \fB\fCpods\fR must
be set to \fB\fCverified\fR for this to function properly.
be set to \fB\fCverified\fR for this to function properly. Furthermore, the remote IP address in the DNS
packet received by CoreDNS must be the IP address of the Pod that sent the request.
.PP
.RS
@@ -294,23 +295,30 @@ The kubernetes plugin will publish the following metadata, if the \fImetadata\fP
plugin is also enabled:
.IP \(bu 4
kubernetes/endpoint: the endpoint name in the query
\fB\fCkubernetes/endpoint\fR: the endpoint name in the query
.IP \(bu 4
kubernetes/kind: the resource kind (pod or svc) in the query
\fB\fCkubernetes/kind\fR: the resource kind (pod or svc) in the query
.IP \(bu 4
kubernetes/namespace: the namespace in the query
\fB\fCkubernetes/namespace\fR: the namespace in the query
.IP \(bu 4
kubernetes/port-name: the port name in an SRV query
\fB\fCkubernetes/port-name\fR: the port name in an SRV query
.IP \(bu 4
kubernetes/protocol: the protocol in an SRV query
\fB\fCkubernetes/protocol\fR: the protocol in an SRV query
.IP \(bu 4
kubernetes/service: the service name in the query
\fB\fCkubernetes/service\fR: the service name in the query
.IP \(bu 4
kubernetes/client-namespace: the client pod's namespace, if \fB\fCpods verified\fR mode is enabled
\fB\fCkubernetes/client-namespace\fR: the client pod's namespace (see requirements below)
.IP \(bu 4
kubernetes/client-pod-name: the client pod's name, if \fB\fCpods verified\fR mode is enabled
\fB\fCkubernetes/client-pod-name\fR: the client pod's name (see requirements below)
.PP
The \fB\fCkubernetes/client-namespace\fR and \fB\fCkubernetes/client-pod-name\fR metadata work by reconciling the
client IP address in the DNS request packet to a known pod IP address. Therefore the following is required:
* \fB\fCpods verified\fR mode must be enabled
* the remote IP address in the DNS packet received by CoreDNS must be the IP address
of the Pod that sent the request.
.SH "METRICS"
.PP
If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metrics are exported: