aboutsummaryrefslogtreecommitdiff
path: root/man/coredns-kubernetes.7
diff options
context:
space:
mode:
Diffstat (limited to 'man/coredns-kubernetes.7')
-rw-r--r--man/coredns-kubernetes.732
1 files changed, 20 insertions, 12 deletions
diff --git a/man/coredns-kubernetes.7 b/man/coredns-kubernetes.7
index e71a08739..701871f22 100644
--- a/man/coredns-kubernetes.7
+++ b/man/coredns-kubernetes.7
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "COREDNS\-KUBERNETES" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-KUBERNETES" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
.
.SH "NAME"
\fIkubernetes\fR \- enables the reading zone data from a Kubernetes cluster\.
@@ -13,7 +13,7 @@ This plugin implements the Kubernetes DNS\-Based Service Discovery Specification
CoreDNS running the kubernetes plugin can be used as a replacement for kube\-dns in a kubernetes cluster\. See the deployment \fIhttps://github\.com/coredns/deployment\fR repository for details on how to deploy CoreDNS in Kubernetes \fIhttps://github\.com/coredns/deployment/tree/master/kubernetes\fR\.
.
.P
-stubDomains and upstreamNameservers \fIhttps://kubernetes\.io/blog/2017/04/configuring\-private\-dns\-zones\-upstream\-nameservers\-kubernetes/\fR are implemented via the \fIproxy\fR plugin and kubernetes \fIupstream\fR\. See example below\.
+stubDomains and upstreamNameservers \fIhttps://kubernetes\.io/blog/2017/04/configuring\-private\-dns\-zones\-upstream\-nameservers\-kubernetes/\fR are implemented via the \fIforward\fR plugin and kubernetes \fIupstream\fR\. See the examples below\.
.
.P
This plugin can only be used once per Server Block\.
@@ -70,6 +70,9 @@ kubernetes [ZONES\.\.\.] {
\fBnamespaces\fR \fBNAMESPACE [NAMESPACE\.\.\.]\fR only exposes the k8s namespaces listed\. If this option is omitted all namespaces are exposed
.
.IP "\(bu" 4
+\fBnamespace_labels\fR \fBEXPRESSION\fR only expose the records for Kubernetes namespaces that match this label selector\. The label selector syntax is described in the Kubernetes User Guide \- Labels \fIhttp://kubernetes\.io/docs/user\-guide/labels/\fR\. An example that only exposes namespaces labeled as "istio\-injection=enabled", would use: \fBlabels istio\-injection=enabled\fR\.
+.
+.IP "\(bu" 4
\fBlabels\fR \fBEXPRESSION\fR only exposes the records for Kubernetes objects that match this label selector\. The label selector syntax is described in the Kubernetes User Guide \- Labels \fIhttps://kubernetes\.io/docs/user\-guide/labels/\fR\. An example that only exposes objects labeled as "application=nginx" in the "staging" or "qa" environments, would use: \fBlabels environment in (staging, qa),application=nginx\fR\.
.
.IP "\(bu" 4
@@ -110,8 +113,8 @@ kubernetes [ZONES\.\.\.] {
.
.IP "" 0
.
-.SH "HEALTH"
-This plugin implements dynamic health checking\. Currently this is limited to reporting healthy when the API has synced\.
+.SH "READY"
+This plugin reports readiness to the ready plugin\. This will happen after it has synced to the Kubernetes API\.
.
.SH "EXAMPLES"
Handle all queries in the \fBcluster\.local\fR zone\. Connect to Kubernetes in\-cluster\. Also handle all \fBin\-addr\.arpa\fR \fBPTR\fR requests for \fB10\.0\.0\.0/17\fR \. Verify the existence of pods when answering pod requests\. Resolve upstream records against \fB10\.102\.3\.10\fR\. Note we show the entire server block here:
@@ -163,18 +166,23 @@ kubernetes cluster\.local {
.IP "" 0
.
.SH "STUBDOMAINS AND UPSTREAMNAMESERVERS"
-Here we use the \fIproxy\fR plugin to implement a stubDomain that forwards \fBexample\.local\fR to the nameserver \fB10\.100\.0\.10:53\fR\. The \fIupstream\fR option in the \fIkubernetes\fR plugin means that ExternalName services (CNAMEs) will be resolved using the respective proxy\. Also configured is an upstreamNameserver \fB8\.8\.8\.8:53\fR that will be used for resolving names that do not fall in \fBcluster\.local\fR or \fBexample\.local\fR\.
+Here we use the \fIforward\fR plugin to implement a stubDomain that forwards \fBexample\.local\fR to the nameserver \fB10\.100\.0\.10:53\fR\. The \fIupstream\fR option in the \fIkubernetes\fR plugin means that ExternalName services (CNAMEs) will be resolved using the respective proxy\. Also configured is an upstreamNameserver \fB8\.8\.8\.8:53\fR that will be used for resolving names that do not fall in \fBcluster\.local\fR or \fBexample\.local\fR\.
.
.IP "" 4
.
.nf
-\&\.:53 {
+cluster\.local:53 {
kubernetes cluster\.local {
upstream
}
- proxy example\.local 10\.100\.0\.10:53
- proxy \. 8\.8\.8\.8:53
+}
+example\.local {
+ forward \. 10\.100\.0\.10:53
+}
+
+\. {
+ forward \. 8\.8\.8\.8:53
}
.
.fi
@@ -188,10 +196,10 @@ The configuration above represents the following Kube\-DNS stubDomains and upstr
.
.nf
- stubDomains: |
- {“example\.local”: [“10\.100\.0\.10:53”]}
- upstreamNameservers: |
- [“8\.8\.8\.8:53”]
+stubDomains: |
+ {“example\.local”: [“10\.100\.0\.10:53”]}
+upstreamNameservers: |
+ [“8\.8\.8\.8:53”]
.
.fi
.