From 992e7928c7c258628d2b13b769acc86781b9faea Mon Sep 17 00:00:00 2001 From: Chris O'Haver Date: Mon, 23 Jul 2018 15:37:41 -0400 Subject: [PATCH] Document current limitations of loop (#1996) * Document current limitations of loop * Update README.md --- plugin/loop/README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/plugin/loop/README.md b/plugin/loop/README.md index 0b02a5158..bf0b93b68 100644 --- a/plugin/loop/README.md +++ b/plugin/loop/README.md @@ -2,7 +2,7 @@ ## Name -*loop* - detect forwarding loops and halt the server. +*loop* - detect simple forwarding loops and halt the server. ## Description @@ -13,7 +13,7 @@ The plugin will try to send the query for up to 30 seconds. This is done to give to start up. Once a query has been successfully sent *loop* disables itself to prevent a query of death. -The query send is `..zone` with type set to HINFO. +The query sent is `..zone` with type set to HINFO. ## Syntax @@ -38,3 +38,10 @@ After CoreDNS has started it stops the process while logging: ~~~ txt plugin/loop: Seen "HINFO IN 5577006791947779410.8674665223082153551." more than twice, loop detected ~~~ + +## Limitations + +This plugin only attempts to find simple static forwarding loops at start up time. To detect a loop, all of the following must be true + +* the loop must be present at start up time. +* the loop must occur for at least the `HINFO` query type.