mirror of
https://github.com/coredns/coredns.git
synced 2025-10-27 00:04:15 -04:00
docs: Regenerate all manpages using mmark (#2762)
Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
GitHub
@@ -1,94 +1,112 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "COREDNS\-K8S_EXTERNAL" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fIk8s_external\fR \- resolve load balancer and external IPs from outside kubernetes clusters\.
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
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\fR plugin is also loaded\.
|
||||
.
|
||||
.P
|
||||
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\.
|
||||
.
|
||||
.P
|
||||
By default the apex of the zone will look like (assuming the zone used is \fBexample\.org\fR):
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-K8S_EXTERNAL" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH K8S_EXTERNAL
|
||||
.SH NAME
|
||||
.PP
|
||||
\fIk8s_external\fP - resolve load balancer and external IPs from outside kubernetes clusters.
|
||||
|
||||
.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.
|
||||
|
||||
.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.
|
||||
|
||||
.PP
|
||||
By default the apex of the zone will look like (assuming the zone used is \fB\fCexample.org\fR):
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
example.org. 5 IN SOA ns1.dns.example.org. hostmaster.example.org. (
|
||||
12345 ; serial
|
||||
14400 ; refresh (4 hours)
|
||||
3600 ; retry (1 hour)
|
||||
604800 ; expire (1 week)
|
||||
5 ; minimum (4 hours)
|
||||
)
|
||||
example.org 5 IN NS ns1.dns.example.org.
|
||||
|
||||
example\.org\. 5 IN SOA ns1\.dns\.example\.org\. hostmaster\.example\.org\. (
|
||||
12345 ; serial
|
||||
14400 ; refresh (4 hours)
|
||||
3600 ; retry (1 hour)
|
||||
604800 ; expire (1 week)
|
||||
5 ; minimum (4 hours)
|
||||
)
|
||||
example\.org 5 IN NS ns1\.dns\.example\.org\.
|
||||
ns1.dns.example.org. 5 IN A ....
|
||||
ns1.dns.example.org. 5 IN AAAA ....
|
||||
|
||||
ns1\.dns\.example\.org\. 5 IN A \.\.\.\.
|
||||
ns1\.dns\.example\.org\. 5 IN AAAA \.\.\.\.
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Note we use the \fBdns\fR subdomain to place the records the DNS needs (see the \fBapex\fR directive)\. Also note the SOA\'s serial number is static\. The IP addresses of the nameserver records are those of the CoreDNS service\.
|
||||
.
|
||||
.P
|
||||
The \fIk8s_external\fR plugin handles the subdomain \fBdns\fR and the apex of the zone by itself, all other queries are resolved to addresses in the cluster\.
|
||||
.
|
||||
.SH "SYNTAX"
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Note we use the \fB\fCdns\fR subdomain to place the records the DNS needs (see the \fB\fCapex\fR directive). Also
|
||||
note the SOA's serial number is static. The IP addresses of the nameserver records are those of the
|
||||
CoreDNS service.
|
||||
|
||||
.PP
|
||||
The \fIk8s_external\fP plugin handles the subdomain \fB\fCdns\fR and the apex of the zone by itself, all other
|
||||
queries are resolved to addresses in the cluster.
|
||||
|
||||
.SH SYNTAX
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
k8s\_external [ZONE...]
|
||||
|
||||
k8s_external [ZONE\.\.\.]
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBZONES\fR zones \fIk8s_external\fR should be authoritative for\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If you want to change the apex domain or use a different TTL for the return records you can use this extended syntax\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
k8s_external [ZONE\.\.\.] {
|
||||
.IP \(bu 4
|
||||
\fBZONES\fP zones \fIk8s_external\fP should be authoritative for.
|
||||
|
||||
|
||||
.PP
|
||||
If you want to change the apex domain or use a different TTL for the return records you can use
|
||||
this extended syntax.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
k8s\_external [ZONE...] {
|
||||
apex APEX
|
||||
ttl TTL
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBAPEX\fR is the name (DNS label) to use the apex records, defaults to \fBdns\fR\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBttl\fR allows you to set a custom \fBTTL\fR for responses\. The default is 5 (seconds)\.
|
||||
.
|
||||
.IP "" 0
|
||||
Enable names under \fBexample\.org\fR to be resolved to in cluster DNS addresses\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
kubernetes cluster\.local
|
||||
k8s_external example\.org
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
For some background see resolve external IP address \fIhttps://github\.com/kubernetes/dns/issues/242\fR\. And A records for services with Load Balancer IP \fIhttps://github\.com/coredns/coredns/issues/1851\fR\.PTR queries for the reverse zone is not supported\.
|
||||
.RE
|
||||
|
||||
.IP \(bu 4
|
||||
\fBAPEX\fP is the name (DNS label) to use the apex records, defaults to \fB\fCdns\fR.
|
||||
.IP \(bu 4
|
||||
\fB\fCttl\fR allows you to set a custom \fBTTL\fP for responses. The default is 5 (seconds).
|
||||
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Enable names under \fB\fCexample.org\fR to be resolved to in cluster DNS addresses.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
kubernetes cluster.local
|
||||
k8s\_external example.org
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH ALSO SEE
|
||||
.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].
|
||||
|
||||
.SH BUGS
|
||||
.PP
|
||||
PTR queries for the reverse zone is not supported.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user