Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-11-26 13:44:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

Run make -f Makefile.doc (#1875)

Browse Source 
Fix typo corendns -> coredns in coredns.1
This commit is contained in:
Miek Gieben
2018-06-13 11:02:14 +01:00
committed by GitHub
parent d6288c25ba
commit 6f865a9de7
9 changed files with 50 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
man/coredns-proxy.7
View File

@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "COREDNS\-PROXY" "7" "May 2018" "CoreDNS" "CoreDNS plugins"
.TH "COREDNS\-PROXY" "7" "June 2018" "CoreDNS" "CoreDNS plugins"
.
.SH "NAME"
\fIproxy\fR \- facilitates both a basic reverse proxy and a robust load balancer\.
@@ -44,7 +44,7 @@ proxy FROM TO\.\.\. {
health_check PATH:PORT [DURATION]
except IGNORED_NAMES\.\.\.
spray
protocol [dns [force_tcp]|https_google [bootstrap ADDRESS\.\.\.]|grpc [insecure|CACERT|KEY CERT|KEY CERT CACERT]]
protocol [dns [force_tcp]|grpc [insecure|CACERT|KEY CERT|KEY CERT CACERT]]
}
.
.fi
@@ -76,7 +76,7 @@ proxy FROM TO\.\.\. {
\fBspray\fR when all backends are unhealthy, randomly pick one to send the traffic to\. (This is a failsafe\.)
.
.IP "\(bu" 4
\fBprotocol\fR specifies what protocol to use to speak to an upstream, \fBdns\fR (the default) is plain old DNS, and \fBhttps_google\fR uses \fBhttps://dns\.google\.com\fR and speaks a JSON DNS dialect\. Note when using this \fBTO\fR will be ignored\. The \fBgrpc\fR option will talk to a server that has implemented the DnsService \fIhttps://github\.com/coredns/coredns/blob/master/pb/dns\.proto\fR\.
\fBprotocol\fR specifies what protocol to use to speak to an upstream, \fBdns\fR (the default) is plain old DNS\. The \fBgrpc\fR option will talk to a server that has implemented the DnsService \fIhttps://github\.com/coredns/coredns/blob/master/pb/dns\.proto\fR\.
.
.IP "" 0
.
@@ -87,7 +87,6 @@ There are four load\-balancing policies available: * \fBrandom\fR (default) \- R
All polices implement randomly spraying packets to backend hosts when \fIno healthy\fR hosts are available\. This is to preeempt the case where the healthchecking (as a mechanism) fails\.
.
.SH "UPSTREAM PROTOCOLS"
Currently \fBprotocol\fR supports \fBdns\fR (i\.e\., standard DNS over UDP/TCP) and \fBhttps_google\fR (JSON payload over HTTPS)\. Note that with \fBhttps_google\fR the entire transport is encrypted\. Only \fIyou\fR and \fIGoogle\fR can see your DNS activity\.
.
.TP
\fBdns\fR
@@ -114,13 +113,6 @@ None \- No client authentication is used, and the system CAs are used to verify
.
.IP "" 0
.
.TP
\fBhttps_google\fR
bootstrap \fBADDRESS\.\.\.\fR is used to (re\-)resolve \fBdns\.google\.com\fR\.
.
.IP
This happens every 300s\. If not specified the default is used: 8\.8\.8\.8:53/8\.8\.4\.4:53\. Note that \fBTO\fR is \fIignored\fR when \fBhttps_google\fR is used, as its upstream is defined as \fBdns\.google\.com\fR\.
.
.SH "METRICS"
If monitoring is enabled (via the \fIprometheus\fR directive) then the following metric is exported:
@@ -134,7 +126,7 @@ If monitoring is enabled (via the \fIprometheus\fR directive) then the following
.IP "" 0
.
.P
Where \fBproxy_proto\fR is the protocol used (\fBdns\fR, \fBgrpc\fR, or \fBhttps_google\fR) and \fBto\fR is \fBTO\fR specified in the config, \fBproto\fR is the protocol used by the incoming query ("tcp" or "udp"), family the transport family ("1" for IPv4, and "2" for IPv6)\. \fBServer\fR is the server responsible for the request (and metric)\. See the documention in the metrics plugin\.
Where \fBproxy_proto\fR is the protocol used (\fBdns\fR or \fBgrpc\fR) and \fBto\fR is \fBTO\fR specified in the config, \fBproto\fR is the protocol used by the incoming query ("tcp" or "udp"), family the transport family ("1" for IPv4, and "2" for IPv6)\. \fBServer\fR is the server responsible for the request (and metric)\. See the documention in the metrics plugin\.
.
.SH "EXAMPLES"
Proxy all requests within example\.org\. to a backend system:
@@ -232,45 +224,4 @@ Proxy everything except \fBexample\.org\fR using the host\'s \fBresolv\.conf\fR\
.fi
.
.IP "" 0
.
.P
Proxy all requests within \fBexample\.org\fR to Google\'s \fBdns\.google\.com\fR\.
.
.IP "" 4
.
.nf
\&\. {
proxy example\.org 1\.2\.3\.4:53 {
protocol https_google
}
}
.
.fi
.
.IP "" 0
.
.P
Proxy everything with HTTPS to \fBdns\.google\.com\fR, except \fBexample\.org\fR\. Then have another proxy in another stanza that uses plain DNS to resolve names under \fBexample\.org\fR\.
.
.IP "" 4
.
.nf
\&\. {
proxy \. 1\.2\.3\.4:53 {
except example\.org
protocol https_google
}
}
example\.org {
proxy \. 8\.8\.8\.8:53
}
.
.fi
.
.IP "" 0
.
.SH "BUGS"
When using the \fBgoogle_https\fR protocol the health checking will health check the wrong endpoint\. See \fIhttps://github\.com/coredns/coredns/issues/1202\fR for some background\.