COREDNS-READY(7)
π COREDNS-READY(7) π
okay so bestie, welcome to the ready page of the CoreDNS manual β yes that's the plugin name and the manual name all at once, we love an economy π
β¨ NAME β¨
ready β enables a readiness check HTTP endpoint. that's it, that's the whole vibe. she tells you when the server is ready to serve π«Ά
πΈ DESCRIPTION πΈ
so by enabling ready, an HTTP endpoint on port 8181 will return 200 OK β but only when all plugins that are able to signal readiness have actually done so. like, everybody's here, everybody's seated, the show can start π
if some of them are not ready yet? the endpoint returns a 503 with a body containing the list of plugins that are not ready. snitch energy, honestly, but useful π
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. and this also means that the same plugin with different configurations (in potentially different Server Blocks) will have their readiness reported as the union of their respective readinesses. like, collective main character energy β everyone's status gets pooled together π
π SYNTAX π
ready [ADDRESS] {
monitor until-ready|continuously
}
ready optionally takes an address; the default is :8181. the path is fixed to /ready β no, you can't change it, it's giving "the rules are the rules" π
the readiness endpoint returns a 200 response code and the word "OK" when this server is ready. it returns a 503 otherwise, plus the list of plugins that are not ready. and by default, once a plugin has signaled it is ready it will not be queried again. one and done, periodt β¨
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. like trusting your bestie to text back, we're not checking twice π«Ά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. highkey the anxious attachment option but honestly iconic for live status π₯
π¦ PLUGINS π¦
any plugin wanting to signal readiness will need to implement the ready.Readiness interface by implementing a method Ready() bool that returns true when the plugin is ready and false otherwise. that's the whole contract, no cap β true good, false not yet π
β EXAMPLES β
let ready report readiness for both the . and example.org servers (assuming the whois plugin also exports readiness):
. {
ready
erratic
}
example.org {
ready
whoami
}
and run ready on a different port:
. {
ready localhost:8091
}
look at her go, custom port and everything π πΈ
and that's the page bestie! brought to you by CoreDNS (the source), version March 2026 (the date) β go be ready, stay ready, slay ππβ¨
π¦ where this page comes from
- nixpkgs unstable: coredns 1.14.7
- opensuse-leap 16.0: coredns-extras 1.15.0-bp160.1.1 Β· Apache-2.0 AND MPL-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms