From 519af5b973796448d4ff96d6ce7f13107419c96a Mon Sep 17 00:00:00 2001 From: Ross McFarland Date: Fri, 29 Sep 2023 13:28:45 -0700 Subject: [PATCH] Rework dynamic documentation to call using the default pool a backup rather than fallback --- docs/dynamic_records.md | 49 ++++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/docs/dynamic_records.md b/docs/dynamic_records.md index 1a4dfd1..e3e2faf 100644 --- a/docs/dynamic_records.md +++ b/docs/dynamic_records.md @@ -30,7 +30,8 @@ test: - value: 4.4.4.4 weight: 3 na: - # Implicit fallback to the default pool (below) + # Implicitly goes to the backup pool (below) if all values are failing + # health checks values: - value: 5.5.5.5 - value: 6.6.6.6 @@ -59,11 +60,13 @@ test: - pool: na ttl: 60 type: A - # These values become a non-healthchecked default pool, generally it should be - # a superset of the catch-all pool and include enough capacity to try and - # serve all global requests (with degraded performance.) The main case they - # will come into play is if all dynamic healthchecks are failing, either on - # the service side or if the providers systems are expeiencing problems. + # These values become a non-healthchecked backup/default pool, generally it + # should be a superset of the catch-all pool and include enough capacity to + # try and serve all global requests (with degraded performance.) The main + # case they will come into play is if all dynamic healthchecks are failing, + # either on the service side or if the providers systems are expeiencing + # problems. They will also be used for when the record is pushed to a + # provider that doesn't support dynamic records. values: - 3.3.3.3 - 4.4.4.4 @@ -81,26 +84,26 @@ If you encounter validation errors in dynamic records suggesting best practices title: Visual Representation of the Rules and Pools --- flowchart LR - query((Query)) --> rule_0[Rule 0
AF-ZA
AS
OC] - rule_0 --no match--> rule_1[Rule 1
AF
EU] - rule_1 --no match--> rule_2["Rule 2
(catch all)"] + query((Query)) --> rule_0[Rule 0
AF-ZA
AS
OC] + rule_0 --no match--> rule_1[Rule 1
AF
EU] + rule_1 --no match--> rule_2["Rule 2
(catch all)"] - rule_0 --match--> pool_apac[Pool apac
1.1.1.1
2.2.2.2] - pool_apac --fallback--> pool_na - rule_1 --match--> pool_eu["Pool eu
3.3.3.3 (2/5)
4.4.4.4 (3/5)"] - pool_eu --fallback--> pool_na - rule_2 --> pool_na[Pool na
5.5.5.5
6.6.6.6
7.7.7.7] - pool_na --fallback--> values[values
3.3.3.3
4.4.4.4
5.5.5.5
6.6.6.6
7.7.7.7] + rule_0 --match--> pool_apac[Pool apac
1.1.1.1
2.2.2.2] + pool_apac --fallback--> pool_na + rule_1 --match--> pool_eu["Pool eu
3.3.3.3 (2/5)
4.4.4.4 (3/5)"] + pool_eu --fallback--> pool_na + rule_2 --> pool_na[Pool na
5.5.5.5
6.6.6.6
7.7.7.7] + pool_na --backup--> values[values
3.3.3.3
4.4.4.4
5.5.5.5
6.6.6.6
7.7.7.7] - classDef queryColor fill:#3B67A8,color:#ffffff - classDef ruleColor fill:#D8F57A,color:#000000 - classDef poolColor fill:#F57261,color:#000000 - classDef valueColor fill:#498FF5,color:#000000 + classDef queryColor fill:#3B67A8,color:#ffffff + classDef ruleColor fill:#D8F57A,color:#000000 + classDef poolColor fill:#F57261,color:#000000 + classDef valueColor fill:#498FF5,color:#000000 - class query queryColor - class rule_0,rule_1,rule_2 ruleColor - class pool_apac,pool_eu,pool_na poolColor - class values valueColor + class query queryColor + class rule_0,rule_1,rule_2 ruleColor + class pool_apac,pool_eu,pool_na poolColor + class values valueColor ```