diff --git a/man/coredns-acl.7 b/man/coredns-acl.7 index 9a2ded0dd..15c25af1d 100644 --- a/man/coredns-acl.7 +++ b/man/coredns-acl.7 @@ -1,12 +1,12 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-ACL" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-ACL" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .PP \fIacl\fP - enforces access control policies on source ip and prevents unauthorized access to DNS servers. .SH "DESCRIPTION" .PP -With \fB\fCacl\fR enabled, users are able to block suspicous DNS queries by configuring IP filter rule sets, i.e. allowing authorized queries to recurse or blocking unauthorized queries. +With \fB\fCacl\fR enabled, users are able to block suspicious DNS queries by configuring IP filter rule sets, i.e. allowing authorized queries to recurse or blocking unauthorized queries. .PP This plugin can be used multiple times per Server Block. diff --git a/man/coredns-autopath.7 b/man/coredns-autopath.7 index 4c3304b29..ce5711bb8 100644 --- a/man/coredns-autopath.7 +++ b/man/coredns-autopath.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-AUTOPATH" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-AUTOPATH" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -36,7 +36,7 @@ If a plugin implements the \fB\fCAutoPather\fR interface then it can be used. .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric is exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metric is exported: .IP \(bu 4 \fB\fCcoredns_autopath_success_count_total{server}\fR - counter of successfully autopath-ed queries. diff --git a/man/coredns-bind.7 b/man/coredns-bind.7 index 92a098962..942536b0f 100644 --- a/man/coredns-bind.7 +++ b/man/coredns-bind.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-BIND" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-BIND" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -60,7 +60,7 @@ To allow processing DNS requests only local host on both IPv4 and IPv6 stacks, u .RE .PP -If the configuration comes up with several \fIbind\fP directives, all addresses are consolidated together: +If the configuration comes up with several \fIbind\fP plugins, all addresses are consolidated together: The following sample is equivalent to the preceding: .PP diff --git a/man/coredns-cache.7 b/man/coredns-cache.7 index 1707f65b6..5481ced31 100644 --- a/man/coredns-cache.7 +++ b/man/coredns-cache.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-CACHE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-CACHE" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -85,7 +85,7 @@ Entries with 0 TTL will remain in the cache until randomly evicted when the shar .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metrics are exported: .IP \(bu 4 \fB\fCcoredns_cache_size{server, type}\fR - Total elements in the cache by cache type. diff --git a/man/coredns-dnssec.7 b/man/coredns-dnssec.7 index df17d2826..07c096110 100644 --- a/man/coredns-dnssec.7 +++ b/man/coredns-dnssec.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-DNSSEC" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-DNSSEC" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -69,7 +69,7 @@ RRSIGs. The default for \fBCAPACITY\fP is 10000. .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metrics are exported: .IP \(bu 4 \fB\fCcoredns_dnssec_cache_size{server, type}\fR - total elements in the cache, type is "signature". diff --git a/man/coredns-erratic.7 b/man/coredns-erratic.7 index 61688ef9d..8c97fc009 100644 --- a/man/coredns-erratic.7 +++ b/man/coredns-erratic.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-ERRATIC" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-ERRATIC" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -7,18 +7,14 @@ .SH "DESCRIPTION" .PP -\fIerratic\fP returns a static response to all queries, but the responses can be delayed, dropped or truncated. -The \fIerratic\fP plugin will respond to every A or AAAA query. For any other type it will return -a SERVFAIL response. The reply for A will return 192.0.2.53 (see RFC -5737 -\[la]https://tools.ietf.org/html/rfc5737\[ra], -for AAAA it returns 2001:DB8::53 (see RFC 3849 -\[la]https://tools.ietf.org/html/rfc3849\[ra]) and for an -AXFR request it will respond with a small zone transfer. - -.PP -\fIerratic\fP can also be used in conjunction with the \fIautopath\fP plugin. This is mostly to aid in -testing. +\fIerratic\fP returns a static response to all queries, but the responses can be delayed, +dropped or truncated. The \fIerratic\fP plugin will respond to every A or AAAA query. For +any other type it will return a SERVFAIL response (except AXFR). The reply for A will return +192.0.2.53 (RFC 5737 +\[la]https://tools.ietf.org/html/rfc5737\[ra]), for AAAA it returns 2001:DB8::53 (RFC +3849 +\[la]https://tools.ietf.org/html/rfc3849\[ra]). For an AXFR request it will respond with a small +zone transfer. .SH "SYNTAX" .PP @@ -65,7 +61,7 @@ example.org { .RE .PP -Or even shorter if the defaults suits you. Note this only drops queries, it does not delay them. +Or even shorter if the defaults suit you. Note this only drops queries, it does not delay them. .PP .RS diff --git a/man/coredns-file.7 b/man/coredns-file.7 index bacd63c7c..6bf360369 100644 --- a/man/coredns-file.7 +++ b/man/coredns-file.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-FILE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-FILE" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -24,7 +24,7 @@ file DBFILE [ZONES...] .IP \(bu 4 \fBDBFILE\fP the database file to read and parse. If the path is relative, the path from the \fIroot\fP -directive will be prepended to it. +plugin will be prepended to it. .IP \(bu 4 \fBZONES\fP zones it should be authoritative for. If empty, the zones from the configuration block are used. diff --git a/man/coredns-forward.7 b/man/coredns-forward.7 index 8efabc22e..3bb51dc4b 100644 --- a/man/coredns-forward.7 +++ b/man/coredns-forward.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-FORWARD" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-FORWARD" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -142,7 +142,7 @@ readTimeout by default is 2 sec, and can decrease automatically down to 200ms .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric are exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metric are exported: .IP \(bu 4 \fB\fCcoredns_forward_request_duration_seconds{to}\fR - duration per upstream interaction. @@ -155,8 +155,6 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following .IP \(bu 4 \fB\fCcoredns_forward_healthcheck_broken_count_total{}\fR - counter of when all upstreams are unhealthy, and we are randomly (this always uses the \fB\fCrandom\fR policy) spraying to an upstream. -.IP \(bu 4 -\fB\fCcoredns_forward_socket_count_total{to}\fR - number of cached sockets per upstream. .PP diff --git a/man/coredns-grpc.7 b/man/coredns-grpc.7 index bcf3b469b..be33ab498 100644 --- a/man/coredns-grpc.7 +++ b/man/coredns-grpc.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-GRPC" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-GRPC" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -90,7 +90,7 @@ Also note the TLS config is "global" for the whole grpc proxy if you need a diff .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric are exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metric are exported: .IP \(bu 4 \fB\fCcoredns_grpc_request_duration_seconds{to}\fR - duration per upstream interaction. diff --git a/man/coredns-health.7 b/man/coredns-health.7 index ecae0d7e2..adbbf4ea9 100644 --- a/man/coredns-health.7 +++ b/man/coredns-health.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-HEALTH" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-HEALTH" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -69,7 +69,7 @@ Doing this is supported but both endpoints ":8080" and ":8081" will export the e .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric is exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metric is exported: .IP \(bu 4 \fB\fCcoredns_health_request_duration_seconds{}\fR - duration to process a HTTP query to the local diff --git a/man/coredns-hosts.7 b/man/coredns-hosts.7 index c9cf7e657..f31a08f3d 100644 --- a/man/coredns-hosts.7 +++ b/man/coredns-hosts.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-HOSTS" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-HOSTS" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -68,7 +68,7 @@ hosts [FILE [ZONES...]] { .IP \(bu 4 \fBFILE\fP the hosts file to read and parse. If the path is relative the path from the \fIroot\fP -directive will be prepended to it. Defaults to /etc/hosts if omitted. We scan the file for changes +plugin will be prepended to it. Defaults to /etc/hosts if omitted. We scan the file for changes every 5 seconds. .IP \(bu 4 \fBZONES\fP zones it should be authoritative for. If empty, the zones from the configuration block @@ -95,7 +95,7 @@ queries for those zones will be subject to fallthrough. .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metrics are exported: .IP \(bu 4 \fB\fCcoredns_hosts_entries_count{}\fR - The combined number of entries in hosts and Corefile. diff --git a/man/coredns-import.7 b/man/coredns-import.7 index 918e4a2cd..ba3dfb52a 100644 --- a/man/coredns-import.7 +++ b/man/coredns-import.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-IMPORT" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-IMPORT" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -11,7 +11,7 @@ The \fIimport\fP plugin can be used to include files into the main configuration reference predefined snippets. Both can help to avoid some duplication. .PP -This is a unique directive in that \fIimport\fP can appear outside of a server block. In other words, it +This is a unique plugin in that \fIimport\fP can appear outside of a server block. In other words, it can appear at the top of a Corefile where an address would normally be. .SH "SYNTAX" diff --git a/man/coredns-kubernetes.7 b/man/coredns-kubernetes.7 index 2c7baf8c3..e3b5e3177 100644 --- a/man/coredns-kubernetes.7 +++ b/man/coredns-kubernetes.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-KUBERNETES" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-KUBERNETES" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -37,7 +37,7 @@ kubernetes [ZONES...] .RE .PP -With only the directive specified, the \fIkubernetes\fP plugin will default to the zone specified in +With only the plugin specified, the \fIkubernetes\fP plugin will default to the zone specified in the server's block. It will handle all queries in that zone and connect to Kubernetes in-cluster. It will not provide PTR records for services or A records for pods. If \fBZONES\fP is used it specifies all the zones the plugin should be authoritative for. @@ -308,9 +308,6 @@ For example, wildcards can be used to resolve all Endpoints for a Service as \fB .fi .RE -.PP -This response can be randomized using the \fB\fCloadbalance\fR plugin - .SH "METADATA" .PP The kubernetes plugin will publish the following metadata, if the \fImetadata\fP @@ -334,3 +331,31 @@ kubernetes/client-namespace: the client pod's namespace, if \fB\fCpods verified\ kubernetes/client-pod-name: the client pod's name, if \fB\fCpods verified\fR mode is enabled +.SH "METRICS" +.PP +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metrics are exported: + +.IP \(bu 4 +\fB\fCcoredns_kubernetes_dns_programming_duration_seconds{service_kind}\fR - Exports the +DNS programming latency SLI +\[la]https://github.com/kubernetes/community/blob/master/sig-scalability/slos/dns_programming_latency.md\[ra]. +The metrics has the \fB\fCservice_kind\fR label that identifies the kind of the +kubernetes service +\[la]https://kubernetes.io/docs/concepts/services-networking/service\[ra]. +It may take one of the three values: + +.RS +.IP \(en 4 +\fB\fCcluster_ip\fR +.IP \(en 4 +\fB\fCheadless_with_selector\fR +.IP \(en 4 +\fB\fCheadless_without_selector\fR + +.RE + + +.SH "BUGS" +.PP +The duration metric only supports the "headless\fIwith\fPselector" service currently. + diff --git a/man/coredns-reload.7 b/man/coredns-reload.7 index 2ff687df9..a4fdefe8a 100644 --- a/man/coredns-reload.7 +++ b/man/coredns-reload.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-RELOAD" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-RELOAD" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -135,7 +135,7 @@ CoreDNS v1.7.0 and later does parse the Corefile and supports detecting changes .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric is exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metric is exported: .IP \(bu 4 \fB\fCcoredns_reload_failed_count_total{}\fR - counts the number of failed reload attempts. diff --git a/man/coredns-sign.7 b/man/coredns-sign.7 index 06cdf68a7..4f7d02c28 100644 --- a/man/coredns-sign.7 +++ b/man/coredns-sign.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-SIGN" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-SIGN" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -82,7 +82,7 @@ sign DBFILE [ZONES...] { .IP \(bu 4 \fBDBFILE\fP the zone database file to read and parse. If the path is relative, the path from the -\fIroot\fP directive will be prepended to it. +\fIroot\fP plugin will be prepended to it. .IP \(bu 4 \fBZONES\fP zones it should be sign for. If empty, the zones from the configuration block are used. @@ -94,7 +94,7 @@ for \fB\fCK++\fR files. Any metadata in these files (Activate, Pu .IP \(bu 4 \fB\fCdirectory\fR specifies the \fBDIR\fP where CoreDNS should save zones that have been signed. If not given this defaults to \fB\fC/var/lib/coredns\fR. The zones are saved under the name -\fB\fCdb..signed\fR. If the path is relative the path from the \fIroot\fP directive will be prepended +\fB\fCdb..signed\fR. If the path is relative the path from the \fIroot\fP plugin will be prepended to it. diff --git a/man/coredns-template.7 b/man/coredns-template.7 index 948f11f44..8ece38763 100644 --- a/man/coredns-template.7 +++ b/man/coredns-template.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-TEMPLATE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-TEMPLATE" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -93,7 +93,7 @@ The output of the template must be a RFC 1035 .SH "METRICS" .PP -If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported: +If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metrics are exported: .IP \(bu 4 \fB\fCcoredns_template_matches_total{server, regex}\fR the total number of matched requests by regex. diff --git a/man/coredns-tls.7 b/man/coredns-tls.7 index 016c09c2d..1098a50ec 100644 --- a/man/coredns-tls.7 +++ b/man/coredns-tls.7 @@ -1,5 +1,5 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-TLS" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-TLS" 7 "October 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP @@ -14,7 +14,7 @@ all (DNSSEC only signs resource records). .PP The \fItls\fP "plugin" allows you to configure the cryptographic keys that are needed for both -DNS-over-TLS and DNS-over-gRPC. If the \fB\fCtls\fR directive is omitted, then no encryption takes place. +DNS-over-TLS and DNS-over-gRPC. If the \fItls\fP plugin is omitted, then no encryption takes place. .PP The gRPC protobuffer is defined in \fB\fCpb/dns.proto\fR. It defines the proto as a simple wrapper for the diff --git a/man/coredns.1 b/man/coredns.1 index 2e4824ce1..022c9da8b 100644 --- a/man/coredns.1 +++ b/man/coredns.1 @@ -1,9 +1,9 @@ -.\" Generated by Mmark Markdown Processer - mmark.nl -.TH "COREDNS" 1 "April 2019" "CoreDNS" "CoreDNS" +.\" Generated by Mmark Markdown Processer - mmark.miek.nl +.TH "COREDNS" 1 "October 2019" "CoreDNS" "CoreDNS" .SH "COREDNS" .PP -\fIcoredns\fP - plugable DNS nameserver optimized for service discovery and flexibility. +\fIcoredns\fP - pluggable DNS nameserver optimized for service discovery and flexibility. .SH "SYNOPSIS" .PP @@ -32,9 +32,6 @@ Available options: specify Corefile to load, if not given CoreDNS will look for a \fB\fCCorefile\fR in the current directory. .TP -\fB-cpu\fP \fBCAP\fP -specify maximum CPU capacity in percent. -.TP \fB-dns.port\fP \fBPORT\fP override default port (53) to listen on. .TP @@ -61,5 +58,5 @@ Apache License 2.0 .SH "SEE ALSO" .PP -Corefile(5) coredns-k8s_external(7) coredns-erratic(7) coredns-nsid(7) coredns-hosts(7) coredns-dnssec(7) coredns-health(7) coredns-grpc(7) coredns-ready(7) coredns-file(7) coredns-root(7) coredns-autopath(7) coredns-auto(7) coredns-dnstap(7) coredns-pprof(7) coredns-tls(7) coredns-loadbalance(7) coredns-cache(7) coredns-whoami(7) coredns-bind(7) coredns-loop(7) coredns-import(7) coredns-chaos(7) coredns-template(7) coredns-log(7) coredns-kubernetes(7) coredns-forward(7) coredns-debug(7) coredns-secondary(7) coredns-route53(7) coredns-errors(7) coredns-metrics(7) coredns-reload(7) coredns-rewrite(7) coredns-metadata(7) coredns-federation(7) coredns-etcd(7) coredns-cancel(7) coredns-trace(7). +Corefile(5) coredns-k8s_external(7) coredns-erratic(7) coredns-nsid(7) coredns-any(7) coredns-hosts(7) coredns-acl(7) coredns-dnssec(7) coredns-health(7) coredns-grpc(7) coredns-sign(7) coredns-file(7) coredns-root(7) coredns-autopath(7) coredns-auto(7) coredns-clouddns(7) coredns-dnstap(7) coredns-pprof(7) coredns-tls(7) coredns-loadbalance(7) coredns-cache(7) coredns-ready(7) coredns-whoami(7) coredns-bind(7) coredns-loop(7) coredns-import(7) coredns-chaos(7) coredns-template(7) coredns-azure(7) coredns-log(7) coredns-kubernetes(7) coredns-forward(7) coredns-debug(7) coredns-secondary(7) coredns-route53(7) coredns-errors(7) coredns-metrics(7) coredns-reload(7) coredns-rewrite(7) coredns-metadata(7) coredns-etcd(7) coredns-cancel(7) coredns-trace(7).