mirror of
https://github.com/coredns/coredns.git
synced 2025-11-29 23:24:26 -05:00
Doc update (#2792)
* Fix spelling in coredns.1 and corefile.7 md files * Run make -f Makefile.doc 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-KUBERNETES" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-KUBERNETES" 7 "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH NAME
|
||||
.SH "NAME"
|
||||
.PP
|
||||
\fIkubernetes\fP - enables the reading zone data from a Kubernetes cluster.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
This plugin implements the Kubernetes DNS-Based Service Discovery
|
||||
Specification
|
||||
@@ -26,7 +26,7 @@ are implemented via the \fIforward\fP plugin and kubernetes \fIupstream\fP. See
|
||||
.PP
|
||||
This plugin can only be used once per Server Block.
|
||||
|
||||
.SH SYNTAX
|
||||
.SH "SYNTAX"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -55,7 +55,7 @@ kubernetes [ZONES...] {
|
||||
labels EXPRESSION
|
||||
pods POD\-MODE
|
||||
endpoint\_pod\_names
|
||||
upstream [ADDRESS...]
|
||||
upstream
|
||||
ttl TTL
|
||||
noendpoints
|
||||
transfer to ADDRESS...
|
||||
@@ -125,10 +125,9 @@ follows: Use the hostname of the endpoint, or if hostname is not set, use the
|
||||
pod name of the pod targeted by the endpoint. If there is no pod targeted by
|
||||
the endpoint, use the dashed IP address form.
|
||||
.IP \(bu 4
|
||||
\fB\fCupstream\fR [\fBADDRESS\fP...] defines the upstream resolvers used for resolving services
|
||||
that point to external hosts (aka External Services, aka CNAMEs). If no \fBADDRESS\fP is given, CoreDNS
|
||||
will resolve External Services against itself. \fBADDRESS\fP can be an IP, an IP:port, or a path
|
||||
to a file structured like resolv.conf.
|
||||
\fB\fCupstream\fR defines the upstream resolvers used for resolving services
|
||||
that point to external hosts (aka External Services, aka CNAMEs). CoreDNS
|
||||
will resolve External Services against itself.
|
||||
.IP \(bu 4
|
||||
\fB\fCttl\fR allows you to set a custom TTL for responses. The default is 5 seconds. The minimum TTL allowed is
|
||||
0 seconds, and the maximum is capped at 3600 seconds. Setting TTL to 0 will prevent records from being cached.
|
||||
@@ -155,12 +154,12 @@ This allows the querying pod to continue searching for the service in the search
|
||||
The search path could, for example, include another Kubernetes cluster.
|
||||
|
||||
|
||||
.SH READY
|
||||
.SH "READY"
|
||||
.PP
|
||||
This plugin reports readiness to the ready plugin. This will happen after it has synced to the
|
||||
Kubernetes API.
|
||||
|
||||
.SH EXAMPLES
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
Handle all queries in the \fB\fCcluster.local\fR zone. Connect to Kubernetes in-cluster. Also handle all
|
||||
\fB\fCin-addr.arpa\fR \fB\fCPTR\fR requests for \fB\fC10.0.0.0/17\fR . Verify the existence of pods when answering pod
|
||||
@@ -209,7 +208,7 @@ kubernetes cluster.local {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH STUBDOMAINS AND UPSTREAMNAMESERVERS
|
||||
.SH "STUBDOMAINS AND UPSTREAMNAMESERVERS"
|
||||
.PP
|
||||
Here we use the \fIforward\fP plugin to implement a stubDomain that forwards \fB\fCexample.local\fR to the nameserver \fB\fC10.100.0.10:53\fR.
|
||||
The \fIupstream\fP option in the \fIkubernetes\fP plugin means that ExternalName services (CNAMEs) will be resolved using the respective proxy.
|
||||
@@ -251,7 +250,7 @@ upstreamNameservers: |
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH AUTOPATH
|
||||
.SH "AUTOPATH"
|
||||
.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
|
||||
@@ -271,7 +270,7 @@ cluster.local {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH FEDERATION
|
||||
.SH "FEDERATION"
|
||||
.PP
|
||||
The \fIkubernetes\fP plugin can be used in conjunction with the \fIfederation\fP plugin. Using this
|
||||
feature enables serving federated domains from the Kubernetes clusters.
|
||||
@@ -291,7 +290,7 @@ cluster.local {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH WILDCARDS
|
||||
.SH "WILDCARDS"
|
||||
.PP
|
||||
Some query labels accept a wildcard value to match any value. If a label is a valid wildcard (*,
|
||||
or the word "any"), then that label will match all values. The labels that accept wildcards are:
|
||||
|
||||
Reference in New Issue
Block a user