NMS-15776: Added docs and modified defaults

OpenNMS · Jun 28, 2023 · af9ffb6 · af9ffb6
1 parent d57a00a
commit af9ffb6
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 4 deletions.
diff --git a/docs/modules/operation/pages/deep-dive/provisioning/scalability.adoc b/docs/modules/operation/pages/deep-dive/provisioning/scalability.adoc
@@ -88,3 +88,29 @@ For a large number of devices, you may want to set the `scan-interval` to `0` to
 NOTE: Even if `scan-interval` is set to `0`, new nodes added to a requisition are scanned during import.
 You can also disable this scan by setting `scan-interval` to `-1`.
 
+=== Tuning DNS reverse lookups
+
+During the provisioning process hostnames are determined for each interface IP address by a DNS reverse lookups.
+A thread pool is used to allow concurrent DNS lookups.
+This thread pool can be configured by the following properties:
+
+.Thread pool configuration parameters for DNS lookups
+[options="header"]
+[cols="1,3,2"]
+|===
+| Parameter
+| Description
+| Default value
+
+| org.opennms.netmgt.provision.dns.client.rpc.maxThreadPoolSize
+| Maximum thread pool size.
+|
+64
+| org.opennms.netmgt.provision.dns.client.rpc.queueCapacity
+| Maximum queue size for pending DNS lookups.
+|
+4096
+|===
+
+NOTE: DNS reverse lookups can be disabled completely by setting the property `org.opennms.provisiond.reverseResolveRequisitionIpInterfaceHostnames` to `false`.
+
diff --git a/opennms-base-assembly/src/main/filtered/etc/opennms.properties b/opennms-base-assembly/src/main/filtered/etc/opennms.properties
@@ -861,6 +861,14 @@ org.opennms.newts.nan_on_counter_wrap=true
 # By default this property is not used and empty.
 # org.opennms.netmgt.search.info=
 
-# # ###### Mate Expressions ######
+# ###### Mate Expressions ######
 # Limit of recursion depth while evaluating mate expressions
 # org.opennms.mate.maxRecursionDepth=8
+
+# ###### DNS tuning options ######
+# A thread pool is used to allow concurrent DNS lookups on OpenNMS instance.
+# org.opennms.netmgt.provision.dns.client.rpc.maxThreadPoolSize=64
+# org.opennms.netmgt.provision.dns.client.rpc.queueCapacity=4096
+
+# By default hostnames are determined for a node's IP addresses during the provisioning's audit phase.
+# org.opennms.provisiond.reverseResolveRequisitionIpInterfaceHostnames=true
diff --git a/...nms-detectorclient-rpc/src/main/resources/META-INF/opennms/applicationContext-rpc-dns.xml b/...nms-detectorclient-rpc/src/main/resources/META-INF/opennms/applicationContext-rpc-dns.xml
@@ -12,8 +12,8 @@
 	<context:annotation-config />
 
     <bean id="dnsLookupClientRpcModule" class="org.opennms.netmgt.provision.dns.client.rpc.DnsLookupClientRpcModule" >
-        <constructor-arg value="64"/>   <!-- maxThreadPoolSize -->
-        <constructor-arg value="1024"/> <!-- queueCapacity -->
+        <constructor-arg value="${org.opennms.netmgt.provision.dns.client.rpc.maxThreadPoolSize:4096}"/>
+        <constructor-arg value="${org.opennms.netmgt.provision.dns.client.rpc.queueCapacity:64}"/>
     </bean>
 
     <bean id="locationAwareDnsClient" class="org.opennms.netmgt.provision.dns.client.rpc.LocationAwareDnsLookupClientRpcImpl" />

diff --git a/...-provision/opennms-detectorclient-rpc/src/main/resources/OSGI-INF/blueprint/blueprint.xml b/...-provision/opennms-detectorclient-rpc/src/main/resources/OSGI-INF/blueprint/blueprint.xml
@@ -13,7 +13,7 @@
 
     <cm:property-placeholder id="dnsLookupProperties" persistent-id="org.opennms.netmgt.provision.dns.client.rpc" update-strategy="reload">
         <cm:default-properties>
-            <cm:property name="queueCapacity" value="1024"/>
+            <cm:property name="queueCapacity" value="4096"/>
             <cm:property name="maxThreadPoolSize" value="64"/>
         </cm:default-properties>
     </cm:property-placeholder>