Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
COREDNS-READY(7)		 CoreDNS Plugins		COREDNS-READY(7)

NAME
     ready - enables a readiness check HTTP endpoint.

DESCRIPTION
     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.

     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 same plugin with different configu-
     rations (in potentially different Server Blocks) will have their  readiness
     reported as the union of their respective readinesses.

SYNTAX
	    ready [ADDRESS]

     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.

PLUGINS
     Any  plugin  wanting  to  signal  readiness  will	need  to  implement  the
     ready.Readiness  interface  by  implementing a method Ready() bool that re-
     turns true when the plugin is ready and false otherwise.

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
	    }

     Run ready on a different port.

	    . {
		ready localhost:8091
	    }

CoreDNS 			   March 2021			COREDNS-READY(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=coredns-ready&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help