mirror of
https://github.com/coredns/coredns.git
synced 2026-04-09 21:45:32 -04:00
chore(docs): regenerate man pages (#7971)
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
|
||||
.TH "COREDNS-READY" 7 "March 2021" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-READY" 7 "March 2026" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH "NAME"
|
||||
.PP
|
||||
@@ -9,8 +9,7 @@
|
||||
.PP
|
||||
By enabling \fIready\fP an HTTP endpoint on port 8181 will return 200 OK, when all plugins that are able
|
||||
to signal readiness have done so. If some are not ready yet the endpoint will return a 503 with the
|
||||
body containing the list of plugins that are not ready. Once a plugin has signaled it is ready it
|
||||
will not be queried again.
|
||||
body containing the list of plugins that are not ready.
|
||||
|
||||
.PP
|
||||
Each Server Block that enables the \fIready\fP plugin will have the plugins \fIin that server block\fP
|
||||
@@ -23,7 +22,9 @@ their readiness reported as the union of their respective readinesses.
|
||||
.RS
|
||||
|
||||
.nf
|
||||
ready [ADDRESS]
|
||||
ready [ADDRESS] {
|
||||
monitor until\-ready|continuously
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
@@ -32,6 +33,16 @@ ready [ADDRESS]
|
||||
\fIready\fP optionally takes an address; the default is \fB\fC:8181\fR. The path is fixed to \fB\fC/ready\fR. The
|
||||
readiness endpoint returns a 200 response code and the word "OK" when this server is ready. It
|
||||
returns a 503 otherwise \fIand\fP the list of plugins that are not ready.
|
||||
By default, once a plugin has signaled it is ready it will not be queried again.
|
||||
|
||||
.PP
|
||||
The \fIready\fP directive can include an optional \fB\fCmonitor\fR parameter, defaulting to \fB\fCuntil-ready\fR. The following values are supported:
|
||||
|
||||
.IP \(bu 4
|
||||
\fB\fCuntil-ready\fR - once a plugin signals it is ready, it will not be checked again. This mode assumes stability after the initial readiness confirmation.
|
||||
.IP \(bu 4
|
||||
\fB\fCcontinuously\fR - in this mode, plugins are continuously monitored for readiness. This means a plugin may transition between ready and not ready states, providing real-time status updates.
|
||||
|
||||
|
||||
.SH "PLUGINS"
|
||||
.PP
|
||||
|
||||
Reference in New Issue
Block a user