From 090fc7184836e075fd9181d9640854e4487b3eda Mon Sep 17 00:00:00 2001 From: Viranch Mehta Date: Tue, 28 Sep 2021 16:06:57 -0700 Subject: [PATCH] Document the new status flag --- docs/dynamic_records.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/dynamic_records.md b/docs/dynamic_records.md index a992eda..d7ab509 100644 --- a/docs/dynamic_records.md +++ b/docs/dynamic_records.md @@ -105,6 +105,30 @@ test: | port | port to check | 443 | | protocol | HTTP/HTTPS/TCP | HTTPS | +Healthchecks can also be skipped for individual pool values. These values can be forced to always-serve or never-serve using the `status` flag. + +`status` flag is optional and accepts one of three possible values, `up`/`down`/`obey`, with `obey` being the default: + +```yaml +test: + ... + dynamic: + pools: + na: + values: + - value: 1.2.3.4 + status: down + - value: 2.3.4.5 + status: up + - value: 3.4.5.6 + # defaults to status: obey + ... +``` + +* NS1 supports all 3 flags values +* Azure DNS supports only `obey` and `down` +* All other dynamic-capable providers only support the default `obey` + #### Route53 Healtch Check Options | Key | Description | Default |