dnsdist: New YAML documentation format

pdns/dnsdistdist/dnsdist-actions-definitions.yml

@@ -1,5 +1,6 @@
 ---
 - name: "allow"
+  description: "Let these packets go through."
 - name: "delay"
   parameters:
     - name: "msec"

pdns/dnsdistdist/dnsdist-response-actions-definitions.yml

@@ -1,12 +1,15 @@
 ---
 - name: "allow"
+  description: "Let these packets go through."
 - name: "ClearRecordTypes"
+  description: "Removes given type(s) records from the response. Beware you can accidentally turn the answer into a NODATA response without a SOA record in the additional section in which case you may want to use NegativeAndSOAAction() to generate an answer, see example below. Subsequent rules are processed after this action."
   skip-cpp: true
   skip-rust: true
   parameters:
     - name: "types"
       type: "Vec<u16>"
       default: true
+      description: "List of types to remove"
 - name: "delay"
   parameters:
     - name: "msec"

pdns/dnsdistdist/dnsdist-rust-lib/dnsdist-settings-definitions.yml

@@ -9,98 +9,127 @@ global:
     - name: "backends"
       type: "Vec<BackendConfiguration>"
       default: true
+      description: "List of backends"
     - name: "binds"
       type: "Vec<BindConfiguration>"
       default: true
+      description: "List of endpoints to accept queries on"
     - name: "cache-hit-response-rules"
       type: "Vec<ResponseRuleConfiguration>"
       default: true
       skip-serde: true
+      description: "List of rules executed on a cache hit"
     - name: "cache-inserted-response-rules"
       type: "Vec<ResponseRuleConfiguration>"
       default: true
       skip-serde: true
+      description: "List of rules executed after inserting a new response into the cache"
     - name: "cache-miss-rules"
       type: "Vec<QueryRuleConfiguration>"
       default: true
       skip-serde: true
+      description: "List of rules executed after a cache miss"
     - name: "cache-settings"
       type: "CacheSettingsConfiguration"
       default: true
+      description: "Caching-related settings"
     - name: "console"
       type: "ConsoleConfiguration"
       default: true
+      description: "Console-related settings"
     - name: "dynamic-rules"
       type: "Vec<DynamicRulesConfiguration>"
       default: true
+      description: "List of dynamic rules"
     - name: "dynamic-rules-settings"
       type: "DynamicRulesSettingsConfiguration"
       default: true
+      description: "Dynamic rules-related settings"
     - name: "edns-client-subnet"
       type: "EdnsClientSubnetConfiguration"
       default: true
+      description: "EDNS Client Subnet-related settings"
     - name: "general"
       type: "GeneralConfiguration"
       default: true
+      description: "General settings"
     - name: "key-value-stores"
       type: "KeyValueStoresConfiguration"
       default: true
+      description: "Key-Value stores"
     - name: "load-balancing-policies"
       type: "LoadBalancingPoliciesConfiguration"
       default: true
+      description: "Load-balancing policies"
     - name: "metrics"
       type: "MetricsConfiguration"
       default: true
+      description: "Metrics-related settings"
     - name: "packet-caches"
       type: "Vec<PacketCacheConfiguration>"
       default: true
+      description: "Packet-cache definitions"
     - name: "pools"
       type: "Vec<PoolConfiguration>"
       default: true
+      description: "Pools of backends"
     - name: "proxy-protocol"
       type: "ProxyProtocolConfiguration"
       default: true
+      description: "Proxy-protocol-related settings"
     - name: "query-count"
       type: "QueryCountConfiguration"
       default: true
+      description: "Queries counting-related settings"
     - name: "query-rules"
       type: "Vec<QueryRuleConfiguration>"
       default: true
       skip-serde: true
+      description: "List of rules executed when a query is received"
     - name: "remote-logging"
       type: "RemoteLoggingConfiguration"
       default: true
+      description: "Remote logging-related settings"
     - name: "response-rules"
       type: "Vec<ResponseRuleConfiguration>"
       default: true
       skip-serde: true
+      description: "List of rules executed when a response is received"
     - name: "ring-buffers"
       type: "RingBuffersConfiguration"
       default: true
+      description: "In-memory ring buffer settings"
     - name: "security-polling"
       type: "SecurityPollingConfiguration"
       default: true
+      description: "Automatic checking of outdated version"
     - name: "selectors"
       type: "Vec<Selector>"
       default: true
       skip-serde: true
+      description: "List of selectors that can be reused in rules"
     - name: "self-answered-response-rules"
       type: "Vec<ResponseRuleConfiguration>"
       default: true
       skip-serde: true
+      description: "List of rules executed when a response is generated by DNSdist itself"
     - name: "snmp"
       type: "SnmpConfiguration"
       default: true
+      description: "SNMP-related settings"
     - name: "tuning"
       type: "TuningConfiguration"
       default: true
+      description: "Performance-related settings"
     - name: "webserver"
       type: "WebserverConfiguration"
       default: true
+      description: "Internal web server configuration"
     - name: "xfr-response-rules"
       type: "Vec<ResponseRuleConfiguration>"
       default: true
       skip-serde: true
+      description: "List of rules executed when a XFR response is received"
 
 metrics:
   parameters: