8927 plugin search (#10489)

* #7016 base search classes

* 7016 add search indexes

* 7016 add search indexes

* 7016 add search indexes

* 7016 add search indexes

* 7016 add search indexes

* 7016 add search indexes

* 8927 refactor search

* 8927 refactor search

* 8927 refactor search

* 8927 refactor search

* 8927 get search choices working

* 8927 cleanup - optimize

* 8927 use backend search function

* 8927 fix for plugin search

* 8927 add docs

* Move search app to a module under netbox/

* Utilize global registry to register model search classes

* Build search form options from registry

* Determine search categories from model app by default

* Enable dynamic search registration for plugins

* Update docs & improve plugin support

* Clean up search backend class

* Docs for #8927

Co-authored-by: jeremystretch <jstretch@ns1.com>

netbox/ipam/apps.py

@@ -6,4 +6,4 @@ class IPAMConfig(AppConfig):
     verbose_name = "IPAM"
 
     def ready(self):
-        import ipam.signals
+        from . import signals, search

netbox/ipam/search.py

@@ -0,0 +1,69 @@
+import ipam.filtersets
+import ipam.tables
+from ipam.models import ASN, VLAN, VRF, Aggregate, IPAddress, Prefix, Service
+from netbox.search import SearchIndex, register_search
+
+
+@register_search()
+class VRFIndex(SearchIndex):
+    model = VRF
+    queryset = VRF.objects.prefetch_related('tenant', 'tenant__group')
+    filterset = ipam.filtersets.VRFFilterSet
+    table = ipam.tables.VRFTable
+    url = 'ipam:vrf_list'
+
+
+@register_search()
+class AggregateIndex(SearchIndex):
+    model = Aggregate
+    queryset = Aggregate.objects.prefetch_related('rir')
+    filterset = ipam.filtersets.AggregateFilterSet
+    table = ipam.tables.AggregateTable
+    url = 'ipam:aggregate_list'
+
+
+@register_search()
+class PrefixIndex(SearchIndex):
+    model = Prefix
+    queryset = Prefix.objects.prefetch_related(
+        'site', 'vrf__tenant', 'tenant', 'tenant__group', 'vlan', 'role'
+    )
+    filterset = ipam.filtersets.PrefixFilterSet
+    table = ipam.tables.PrefixTable
+    url = 'ipam:prefix_list'
+
+
+@register_search()
+class IPAddressIndex(SearchIndex):
+    model = IPAddress
+    queryset = IPAddress.objects.prefetch_related('vrf__tenant', 'tenant', 'tenant__group')
+    filterset = ipam.filtersets.IPAddressFilterSet
+    table = ipam.tables.IPAddressTable
+    url = 'ipam:ipaddress_list'
+
+
+@register_search()
+class VLANIndex(SearchIndex):
+    model = VLAN
+    queryset = VLAN.objects.prefetch_related('site', 'group', 'tenant', 'tenant__group', 'role')
+    filterset = ipam.filtersets.VLANFilterSet
+    table = ipam.tables.VLANTable
+    url = 'ipam:vlan_list'
+
+
+@register_search()
+class ASNIndex(SearchIndex):
+    model = ASN
+    queryset = ASN.objects.prefetch_related('rir', 'tenant', 'tenant__group')
+    filterset = ipam.filtersets.ASNFilterSet
+    table = ipam.tables.ASNTable
+    url = 'ipam:asn_list'
+
+
+@register_search()
+class ServiceIndex(SearchIndex):
+    model = Service
+    queryset = Service.objects.prefetch_related('device', 'virtual_machine')
+    filterset = ipam.filtersets.ServiceFilterSet
+    table = ipam.tables.ServiceTable
+    url = 'ipam:service_list'