mirror of
https://github.com/coredns/coredns.git
synced 2026-04-16 17:05:33 -04:00
chore(docs): regenerate man pages (#7971)
This commit is contained in:
@@ -1,19 +1,18 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
|
||||
.TH "COREDNS-K8S_EXTERNAL" 7 "March 2021" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-K8S_EXTERNAL" 7 "March 2026" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH "NAME"
|
||||
.PP
|
||||
\fIk8s_external\fP - resolves load balancer and external IPs from outside Kubernetes clusters.
|
||||
\fIk8s_external\fP - resolves load balancer, external IPs from outside Kubernetes clusters and if enabled headless services.
|
||||
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
This plugin allows an additional zone to resolve the external IP address(es) of a Kubernetes
|
||||
service. This plugin is only useful if the \fIkubernetes\fP plugin is also loaded.
|
||||
service and headless services. This plugin is only useful if the \fIkubernetes\fP plugin is also loaded.
|
||||
|
||||
.PP
|
||||
The plugin uses an external zone to resolve in-cluster IP addresses. It only handles queries for A,
|
||||
AAAA and SRV records; all others result in NODATA responses. To make it a proper DNS zone, it handles
|
||||
SOA and NS queries for the apex of the zone.
|
||||
AAAA, SRV, and PTR records; To make it a proper DNS zone, it handles SOA and NS queries for the apex of the zone.
|
||||
|
||||
.PP
|
||||
By default the apex of the zone will look like the following (assuming the zone used is \fB\fCexample.org\fR):
|
||||
@@ -82,6 +81,38 @@ k8s\_external [ZONE...] {
|
||||
\fB\fCttl\fR allows you to set a custom \fBTTL\fP for responses. The default is 5 (seconds).
|
||||
|
||||
|
||||
.PP
|
||||
If you want to enable headless service resolution, you can do so by adding \fB\fCheadless\fR option.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
k8s\_external [ZONE...] {
|
||||
headless
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.IP \(bu 4
|
||||
if there is a headless service with external IPs set, external IPs will be resolved
|
||||
|
||||
|
||||
.PP
|
||||
If the queried domain does not exist, you can fall through to next plugin by adding the \fB\fCfallthrough\fR option.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
k8s\_external [ZONE...] {
|
||||
fallthrough [ZONE...]
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
Enable names under \fB\fCexample.org\fR to be resolved to in-cluster DNS addresses.
|
||||
@@ -119,12 +150,46 @@ spec:
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
The \fIk8s_external\fP plugin can be used in conjunction with the \fItransfer\fP plugin to enable
|
||||
zone transfers. Notifies are not supported.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
. {
|
||||
transfer example.org {
|
||||
to *
|
||||
}
|
||||
kubernetes cluster.local
|
||||
k8s\_external example.org
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
With the \fB\fCfallthrough\fR option, if the queried domain does not exist, it will be passed to the next plugin that matches the zone.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
kubernetes cluster.local
|
||||
k8s\_external example.org {
|
||||
fallthrough
|
||||
}
|
||||
forward . 8.8.8.8
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
For some background see resolve external IP address
|
||||
\[la]https://github.com/kubernetes/dns/issues/242\[ra].
|
||||
And A records for services with Load Balancer IP
|
||||
\[la]https://github.com/coredns/coredns/issues/1851\[ra].
|
||||
|
||||
.PP
|
||||
PTR queries for the reverse zone is not supported.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user