mirror of
https://github.com/coredns/coredns.git
synced 2025-12-03 00:54:01 -05:00
Do not interrupt querying readiness probes for plugins (#6975)
* Do not interrupt querying readiness probes for plugins Signed-off-by: Gleb Kogtev <gleb.kogtev@gmail.com> * Add monitor param for ready plugin Signed-off-by: Gleb Kogtev <gleb.kogtev@gmail.com> * Update ready docs Signed-off-by: Gleb Kogtev <gleb.kogtev@gmail.com> * Update ready docs Signed-off-by: Gleb Kogtev <gleb.kogtev@gmail.com> --------- Signed-off-by: Gleb Kogtev <gleb.kogtev@gmail.com>
This commit is contained in:
@@ -8,8 +8,7 @@
|
||||
|
||||
By enabling *ready* 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.
|
||||
|
||||
Each Server Block that enables the *ready* plugin will have the plugins *in that server block*
|
||||
report readiness into the /ready endpoint that runs on the same port. This also means that the
|
||||
@@ -19,12 +18,20 @@ their readiness reported as the union of their respective readinesses.
|
||||
## Syntax
|
||||
|
||||
~~~
|
||||
ready [ADDRESS]
|
||||
ready [ADDRESS] {
|
||||
monitor until-ready|continuously
|
||||
}
|
||||
~~~
|
||||
|
||||
*ready* optionally takes an address; the default is `:8181`. The path is fixed to `/ready`. The
|
||||
readiness endpoint returns a 200 response code and the word "OK" when this server is ready. It
|
||||
returns a 503 otherwise *and* the list of plugins that are not ready.
|
||||
returns a 503 otherwise *and* the list of plugins that are not ready.
|
||||
By default, once a plugin has signaled it is ready it will not be queried again.
|
||||
|
||||
The *ready* directive can include an optional `monitor` parameter, defaulting to `until-ready`. The following values are supported:
|
||||
|
||||
* `until-ready` - once a plugin signals it is ready, it will not be checked again. This mode assumes stability after the initial readiness confirmation.
|
||||
* `continuously` - 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.
|
||||
|
||||
## Plugins
|
||||
|
||||
|
||||
Reference in New Issue
Block a user