diff options
author | 2018-04-20 07:24:19 +0100 | |
---|---|---|
committer | 2018-04-20 07:24:19 +0100 | |
commit | 61726b3721b6049f436841fe4c5f7db48d5a39d0 (patch) | |
tree | 76de4d221e204a0564cdb1a788ab6ed8dff911b7 /man/coredns-proxy.7 | |
parent | 19a1ef48f28c5c46e4e8d69d31c8d7a2b579f43e (diff) | |
download | coredns-61726b3721b6049f436841fe4c5f7db48d5a39d0.tar.gz coredns-61726b3721b6049f436841fe4c5f7db48d5a39d0.tar.zst coredns-61726b3721b6049f436841fe4c5f7db48d5a39d0.zip |
Run make -f Makefile.doc (#1705)
Remove trailing white space from proxy/README.md
Diffstat (limited to 'man/coredns-proxy.7')
-rw-r--r-- | man/coredns-proxy.7 | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/man/coredns-proxy.7 b/man/coredns-proxy.7 index c222d2cf0..0b059e192 100644 --- a/man/coredns-proxy.7 +++ b/man/coredns-proxy.7 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "COREDNS\-PROXY" "7" "March 2018" "CoreDNS" "CoreDNS plugins" +.TH "COREDNS\-PROXY" "7" "April 2018" "CoreDNS" "CoreDNS plugins" . .SH "NAME" \fIproxy\fR \- facilitates both a basic reverse proxy and a robust load balancer\. @@ -38,7 +38,7 @@ However, advanced features including load balancing can be utilized with an expa .nf proxy FROM TO\.\.\. { - policy random|least_conn|round_robin|first + policy random|least_conn|round_robin|sequential fail_timeout DURATION max_fails INTEGER health_check PATH:PORT [DURATION] @@ -58,7 +58,7 @@ proxy FROM TO\.\.\. { \fBTO\fR is the destination endpoint to proxy to\. At least one is required, but multiple may be specified\. \fBTO\fR may be an IP:Port pair, or may reference a file in resolv\.conf format . .IP "\(bu" 4 -\fBpolicy\fR is the load balancing policy to use; applies only with multiple backends\. May be one of random, least_conn, round_robin or first\. Default is random\. +\fBpolicy\fR is the load balancing policy to use; applies only with multiple backends\. May be one of random, least_conn, round_robin or sequential\. Default is random\. . .IP "\(bu" 4 \fBfail_timeout\fR specifies how long to consider a backend as down after it has failed\. While it is down, requests will not be routed to that backend\. A backend is "down" if CoreDNS fails to communicate with it\. The default value is 2 seconds ("2s")\. @@ -81,7 +81,7 @@ proxy FROM TO\.\.\. { .IP "" 0 . .SH "POLICIES" -There are three load\-balancing policies available: * \fBrandom\fR (default) \- Randomly select a backend * \fBleast_conn\fR \- Select the backend with the fewest active connections * \fBround_robin\fR \- Select the backend in round\-robin fashion +There are four load\-balancing policies available: * \fBrandom\fR (default) \- Randomly select a backend * \fBleast_conn\fR \- Select the backend with the fewest active connections * \fBround_robin\fR \- Select the backend in round\-robin fashion * \fBsequential\fR \- Select the first available backend looking by order of declaration from left to right * \fBfirst\fR \- Deprecated\. Use sequential instead . .P 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\. @@ -126,15 +126,15 @@ This happens every 300s\. If not specified the default is used: 8\.8\.8\.8:53/8\ If monitoring is enabled (via the \fIprometheus\fR directive) then the following metric is exported: . .IP "\(bu" 4 -\fBcoredns_proxy_request_duration_seconds{proto, proto_proxy, family, to}\fR \- duration per upstream interaction\. +\fBcoredns_proxy_request_duration_seconds{server, proto, proto_proxy, family, to}\fR \- duration per upstream interaction\. . .IP "\(bu" 4 -\fBcoredns_proxy_request_count_total{proto, proto_proxy, family, to}\fR \- query count per upstream\. +\fBcoredns_proxy_request_count_total{server, proto, proto_proxy, family, to}\fR \- query count per upstream\. . .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")\. and family the transport family ("1" for IPv4, and "2" for IPv6)\. +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\. . .SH "EXAMPLES" Proxy all requests within example\.org\. to a backend system: |