datamodel: renamed defer section to prioritization

- renamed /defer/log-period -> /defer/logging-period

Author: alesmrazek

NEWS

@@ -23,6 +23,8 @@ Incompatible changes
   - /webmgmt
   - /workers-max
 - Renamed/moved options in the declarative configuration model (YAML).
+  - /defer/* -> /prioritization/*
+  - /defer/log-period -> /defer/logging-period
   - /network/tls/files-watchdog -> /network/tls/watchdog
   - /dns64: true -> /dns64/enabled: true
   - /dns64/rev-ttl -> /dns64/reverse-ttl

doc/_static/config.schema.json

@@ -1610,16 +1610,16 @@
             },
             "default": null
         },
-        "defer": {
+        "prioritization": {
             "description": "Configuration of request prioritization (defer).",
             "type": "object",
             "properties": {
                 "enabled": {
                     "type": "boolean",
-                    "description": "Use request prioritization.",
+                    "description": "Enable/disable request prioritization.",
                     "default": false
                 },
-                "log-period": {
+                "logging-period": {
                     "type": "string",
                     "pattern": "^(\\d+)(us|ms|s|m|h|d)$",
                     "description": "Minimal time between two log messages, or '0s' to disable.",
@@ -1628,7 +1628,7 @@
             },
             "default": {
                 "enabled": false,
-                "log_period": "0s"
+                "logging_period": "0s"
             }
         },
         "lua": {

python/knot_resolver/datamodel/config_schema.py

@@ -5,7 +5,6 @@
 
 from knot_resolver.constants import API_SOCK_FILE, RUN_DIR, VERSION
 from knot_resolver.datamodel.cache_schema import CacheSchema
-from knot_resolver.datamodel.defer_schema import DeferSchema
 from knot_resolver.datamodel.dns64_schema import Dns64Schema
 from knot_resolver.datamodel.dnssec_schema import DnssecSchema
 from knot_resolver.datamodel.forward_schema import ForwardSchema
@@ -17,6 +16,7 @@
 from knot_resolver.datamodel.monitoring_schema import MonitoringSchema
 from knot_resolver.datamodel.network_schema import NetworkSchema
 from knot_resolver.datamodel.options_schema import OptionsSchema
+from knot_resolver.datamodel.prioritization_schema import PrioritizationSchema
 from knot_resolver.datamodel.rate_limiting_schema import RateLimitingSchema
 from knot_resolver.datamodel.templates import POLICY_CONFIG_TEMPLATE, WORKER_CONFIG_TEMPLATE
 from knot_resolver.datamodel.types import EscapedStr, IntPositive, WritableDir
@@ -106,7 +106,7 @@ class Raw(ConfigSchema):
         monitoring: Metrics exposisition configuration (Prometheus, Graphite)
         lua: Custom Lua configuration.
         rate_limiting: Configuration of rate limiting.
-        defer: Configuration of request prioritization (defer).
+        prioritization: Configuration of request prioritization (defer).
         """
 
         version: int = 1
@@ -126,7 +126,7 @@ class Raw(ConfigSchema):
         logging: LoggingSchema = LoggingSchema()
         monitoring: MonitoringSchema = MonitoringSchema()
         rate_limiting: Optional[RateLimitingSchema] = None
-        defer: DeferSchema = DeferSchema()
+        prioritization: PrioritizationSchema = PrioritizationSchema()
         lua: LuaSchema = LuaSchema()
 
     _LAYER = Raw
@@ -147,7 +147,7 @@ class Raw(ConfigSchema):
     logging: LoggingSchema
     monitoring: MonitoringSchema
     rate_limiting: Optional[RateLimitingSchema]
-    defer: DeferSchema
+    prioritization: PrioritizationSchema
     lua: LuaSchema
 
     def _hostname(self, obj: Raw) -> Any:

python/knot_resolver/datamodel/defer_schema.py

@@ -0,0 +1,15 @@
+from knot_resolver.datamodel.types import TimeUnit
+from knot_resolver.utils.modeling import ConfigSchema
+
+
+class PrioritizationSchema(ConfigSchema):
+    """
+    Configuration of request prioritization (defer).
+
+    ---
+    enabled: Enable/disable request prioritization.
+    logging_period: Minimal time between two log messages, or '0s' to disable.
+    """
+
+    enabled: bool = False
+    logging_period: TimeUnit = TimeUnit("0s")

python/knot_resolver/datamodel/prioritization_schema.py

@@ -35,10 +35,10 @@ cache.open({{ cfg.cache.size_max.bytes() }}, 'lmdb://{{ cfg.cache.storage }}')
 -- FORWARD section ----------------------------------
 {% include "forward.lua.j2" %}
 
--- DEFER section ------------------------------------
+-- PRIORITIZATION section ------------------------------------
 -- Force-disable defer to avoid the default defer config.
-{% set disable_defer = true %}
-{% include "defer.lua.j2" %}
+{% set disable_prioritization = true %}
+{% include "prioritization.lua.j2" %}
 
 {% endif %}
 

python/knot_resolver/datamodel/templates/defer.lua.j2

@@ -0,0 +1,13 @@
+{% if cfg.prioritization.enabled and not disable_prioritization %}
+-- Enable and configure request prioritization (defer)
+assert(
+    C.defer_init(
+        '{{ cfg.rundir }}/defer',
+        {{ cfg.prioritization.logging_period.millis() }},
+        {{ cfg.workers }}
+    ) == 0
+)
+{% else %}
+-- Disable request prioritization (defer)
+assert(C.defer_init(nil, 0, 0) == 0)
+{% endif %}

python/knot_resolver/datamodel/templates/policy-config.lua.j2

@@ -43,8 +43,8 @@ nsid.name('{{ cfg.nsid }}' .. worker.id)
 -- RATE-LIMITING section ------------------------------------
 {% include "rate_limiting.lua.j2" %}
 
--- DEFER section ------------------------------------
-{% include "defer.lua.j2" %}
+-- PRIORITIZATION section ------------------------------------
+{% include "prioritization.lua.j2" %}
 
 {% endif %}
 

python/knot_resolver/datamodel/templates/prioritization.lua.j2

@@ -128,9 +128,9 @@ def config_nodes(config: KresConfig) -> List[Any]:
                 config.dns64,
                 config.logging,
                 config.monitoring,
-                config.lua,
                 config.rate_limiting,
-                config.defer,
+                config.prioritization,
+                config.lua,
             ]
 
         # register and immediately call a verifier that validates config with 'canary' kresd process
@@ -225,7 +225,7 @@ async def validate_config(self, _old: KresConfig, new: KresConfig) -> Result[Non
                     os.unlink(str(_old.rundir) + "/ratelimiting")
                 except FileNotFoundError:
                     pass
-            if _old.workers != new.workers or _old.defer != new.defer:
+            if _old.workers != new.workers or _old.prioritization != new.prioritization:
                 logger.debug("Unlinking shared defer memory")
                 try:
                     os.unlink(str(_old.rundir) + "/defer")