netbox-plugin-dns 1.0.0__tar.gz → 1.0b1__tar.gz

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/PKG-INFO

@@ -1,18 +1,16 @@
 Metadata-Version: 2.1
 Name: netbox-plugin-dns
-Version: 1.0.0
+Version: 1.0b1
 Summary: NetBox DNS is a NetBox plugin for managing DNS data.
 Home-page: https://github.com/peteeckel/netbox-plugin-dns
 License: MIT
 Keywords: netbox,netbox-plugin,dns
 Author: Peter Eckel
 Author-email: pete@netbox-dns.org
-Requires-Python: >=3.8,<4.0
-Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -21,7 +19,7 @@ Project-URL: Repository, https://github.com/peteeckel/netbox-plugin-dns
 Description-Content-Type: text/markdown
 
 # NetBox DNS
-The NetBox DNS plugin enables NetBox to manage operational DNS data such as name servers, zones, records and views, as well as registration data for domains. It can automate tasks like creating PTR records, generating zone serial numbers, NS and SOA records, as well as validate names and values values for resource records to ensure zone data is consistent, up-to-date and compliant with to the relevant RFCs.
+The NetBox DNS plugin enables NetBox to manage operational DNS data such as name servers, zones, records and views, as well as registration data for domains. It can automate tasks like creating PTR records, generating zone serial numbers, NS and SOA records, as well as validate names and values values for resource records to ensure zone data is consistent, current and conforming to the relevant RFCs.
 
 <div align="center">
 <a href="https://pypi.org/project/netbox-plugin-dns/"><img src="https://img.shields.io/pypi/v/netbox-plugin-dns" alt="PyPi"/></a>
@@ -36,30 +34,16 @@ The NetBox DNS plugin enables NetBox to manage operational DNS data such as name
 <a href="https://pepy.tech/project/netbox-plugin-dns"><img alt="Downloads/Month" src="https://static.pepy.tech/badge/netbox-plugin-dns/week"></a>
 </div>
 
-## Objectives
-NetBox DNS is designed to be the 'DNS Source of Truth' analogous to NetBox being the 'Network Source of Truth'.
+## Features
 
-The plugin stores information about DNS name servers, DNS views and zones, and DNS records, making it a data source for automatic provisioning of DNS instances. Registration information about DNS registrars and contacts for DNS domains can also be stored and associated with zones.
+* Manage name servers, zones and records
+* Automatically generate SOA and NS records for zones
+* Automatically create and update PTR records for IPv4 and IPv6 address records
+* Organize DNS zones in views for split horizon DNS and multi-site deployments
+* Manage domain registrar and registrant information for domains related to zones
+* Manage RFC2317 reverse zones for IPv4 prefixes with a network mask length longer than 24 bits
 
-The main focus of the plugin is to ensure the quality of the data stored in it. To achieve this, there are many validation and automation mechanisms in place:
-
-* Validation of record names and values
-* Automatic maintenance of PTR records for IPv6 and IPv4 address records
-* Automatic generation of SOA records, optionally including the serial number of the zone data
-* Validation of record types such as CNAME and singletons, to ensure DNS zone validity
-* Support for [RFC 2317](https://datatracker.ietf.org/doc/html/rfc2317) delegation of PTR zones for IPv4 subnets longer than 24 bits
-
-Other main features include:
-
-* Support for BIND views, providing lightweight namespaces for zones
-* Support for IDN, including the validation of punycode names
-* Full support for the NetBox REST and GraphQL APIs
-* Support for all major NetBox features such as global search, tenancy, change logs, tagging, journaling etc.
-
-## Non-objectives
-In the same way as NetBox is not a network management application, NetBox DNS does not provide any functionality to manage specific name servers or DNS service providers or to generate input such as configuration and zone files for them. The focus is on the completeness and integrity of the data needed to run DNS zones, not on the peculiarities of a plethora of servers and services that actually use the data. This functionality is left to specialized integration tools, or in many cases it can be easily implemented using Ansible or similar tools based on NetBox DNS data. Example code for some simple use cases is provided.
-
-For integration with a large number of DNS server implementations integration tools like [octodns-netbox-dns](https://pypi.org/project/octodns-netbox-dns/) are available.
+NetBox DNS is using the standardized NetBox plugin interface, so it also takes advantage of the NetBox tagging and change log features.
 
 ## Requirements
 
@@ -101,7 +85,7 @@ Full documentation on using plugins with NetBox: [Using Plugins - NetBox Documen
 
 ## Contribute
 
-Contributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)
+Contributions are always welcome! Please see: [contributing guide](CONTRIBUTING.md)
 
 ## Documentation
 

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/README.md

@@ -1,5 +1,5 @@
 # NetBox DNS
-The NetBox DNS plugin enables NetBox to manage operational DNS data such as name servers, zones, records and views, as well as registration data for domains. It can automate tasks like creating PTR records, generating zone serial numbers, NS and SOA records, as well as validate names and values values for resource records to ensure zone data is consistent, up-to-date and compliant with to the relevant RFCs.
+The NetBox DNS plugin enables NetBox to manage operational DNS data such as name servers, zones, records and views, as well as registration data for domains. It can automate tasks like creating PTR records, generating zone serial numbers, NS and SOA records, as well as validate names and values values for resource records to ensure zone data is consistent, current and conforming to the relevant RFCs.
 
 <div align="center">
 <a href="https://pypi.org/project/netbox-plugin-dns/"><img src="https://img.shields.io/pypi/v/netbox-plugin-dns" alt="PyPi"/></a>
@@ -14,30 +14,16 @@ The NetBox DNS plugin enables NetBox to manage operational DNS data such as name
 <a href="https://pepy.tech/project/netbox-plugin-dns"><img alt="Downloads/Month" src="https://static.pepy.tech/badge/netbox-plugin-dns/week"></a>
 </div>
 
-## Objectives
-NetBox DNS is designed to be the 'DNS Source of Truth' analogous to NetBox being the 'Network Source of Truth'.
+## Features
 
-The plugin stores information about DNS name servers, DNS views and zones, and DNS records, making it a data source for automatic provisioning of DNS instances. Registration information about DNS registrars and contacts for DNS domains can also be stored and associated with zones.
+* Manage name servers, zones and records
+* Automatically generate SOA and NS records for zones
+* Automatically create and update PTR records for IPv4 and IPv6 address records
+* Organize DNS zones in views for split horizon DNS and multi-site deployments
+* Manage domain registrar and registrant information for domains related to zones
+* Manage RFC2317 reverse zones for IPv4 prefixes with a network mask length longer than 24 bits
 
-The main focus of the plugin is to ensure the quality of the data stored in it. To achieve this, there are many validation and automation mechanisms in place:
-
-* Validation of record names and values
-* Automatic maintenance of PTR records for IPv6 and IPv4 address records
-* Automatic generation of SOA records, optionally including the serial number of the zone data
-* Validation of record types such as CNAME and singletons, to ensure DNS zone validity
-* Support for [RFC 2317](https://datatracker.ietf.org/doc/html/rfc2317) delegation of PTR zones for IPv4 subnets longer than 24 bits
-
-Other main features include:
-
-* Support for BIND views, providing lightweight namespaces for zones
-* Support for IDN, including the validation of punycode names
-* Full support for the NetBox REST and GraphQL APIs
-* Support for all major NetBox features such as global search, tenancy, change logs, tagging, journaling etc.
-
-## Non-objectives
-In the same way as NetBox is not a network management application, NetBox DNS does not provide any functionality to manage specific name servers or DNS service providers or to generate input such as configuration and zone files for them. The focus is on the completeness and integrity of the data needed to run DNS zones, not on the peculiarities of a plethora of servers and services that actually use the data. This functionality is left to specialized integration tools, or in many cases it can be easily implemented using Ansible or similar tools based on NetBox DNS data. Example code for some simple use cases is provided.
-
-For integration with a large number of DNS server implementations integration tools like [octodns-netbox-dns](https://pypi.org/project/octodns-netbox-dns/) are available.
+NetBox DNS is using the standardized NetBox plugin interface, so it also takes advantage of the NetBox tagging and change log features.
 
 ## Requirements
 
@@ -79,7 +65,7 @@ Full documentation on using plugins with NetBox: [Using Plugins - NetBox Documen
 
 ## Contribute
 
-Contributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)
+Contributions are always welcome! Please see: [contributing guide](CONTRIBUTING.md)
 
 ## Documentation
 

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/__init__.py

@@ -1,20 +1,20 @@
 from netbox.plugins import PluginConfig
 
-__version__ = "1.0.0"
+__version__ = "1.0-beta1"
 
 
 class DNSConfig(PluginConfig):
     name = "netbox_dns"
     verbose_name = "NetBox DNS"
     description = "NetBox plugin for DNS data"
-    min_version = "4.0.0"
+    min_version = "4.0-beta1"
     version = __version__
     author = "Peter Eckel"
     author_email = "pete@netbox-dns.org"
     required_settings = []
     default_settings = {
         "zone_default_ttl": 86400,
-        "zone_soa_ttl": 86400,
+        "zone_soa_serial_auto": True,
         "zone_soa_serial": 1,
         "zone_soa_refresh": 43200,
         "zone_soa_retry": 7200,

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/api/serializers_/view.py

@@ -10,10 +10,6 @@ class ViewSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:view-detail"
     )
-    default_view = serializers.BooleanField(
-        read_only=True,
-    )
-
     tenant = TenantSerializer(nested=True, required=False, allow_null=True)
 
     class Meta:
@@ -23,7 +19,6 @@ class ViewSerializer(NetBoxModelSerializer):
             "url",
             "display",
             "name",
-            "default_view",
             "tags",
             "description",
             "created",
@@ -31,4 +26,4 @@ class ViewSerializer(NetBoxModelSerializer):
             "custom_fields",
             "tenant",
         )
-        brief_fields = ("id", "url", "display", "name", "default_view", "description")
+        brief_fields = ("id", "url", "display", "name", "description")

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/api/serializers_/zone.py

@@ -13,6 +13,17 @@ from netbox_dns.models import Zone
 
 
 class ZoneSerializer(NetBoxModelSerializer):
+    # +
+    # This is a hack to avoid the exception raised by the UniqueTogetherValidator
+    # after NetBox commit https://github.com/netbox-community/netbox/commit/78e284c
+    #
+    # See https://github.com/netbox-community/netbox/issues/15351 for details.
+    # -
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.nested:
+            self.validators = []
+
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:zone-detail"
     )

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/fields/network.py

@@ -9,51 +9,51 @@ from netaddr import AddrFormatError, IPNetwork
 class NetContains(Lookup):
     lookup_name = "net_contains"
 
-    def as_sql(self, compiler, connection):
-        lhs, lhs_params = self.process_lhs(compiler, connection)
-        rhs, rhs_params = self.process_rhs(compiler, connection)
+    def as_sql(self, qn, connection):
+        lhs, lhs_params = self.process_lhs(qn, connection)
+        rhs, rhs_params = self.process_rhs(qn, connection)
         params = lhs_params + rhs_params
-        return f"{lhs} >> {rhs}", params
+        return "%s >> %s" % (lhs, rhs), params
 
 
 class NetContainsOrEquals(Lookup):
     lookup_name = "net_contains_or_equals"
 
-    def as_sql(self, compiler, connection):
-        lhs, lhs_params = self.process_lhs(compiler, connection)
-        rhs, rhs_params = self.process_rhs(compiler, connection)
+    def as_sql(self, qn, connection):
+        lhs, lhs_params = self.process_lhs(qn, connection)
+        rhs, rhs_params = self.process_rhs(qn, connection)
         params = lhs_params + rhs_params
-        return f"{lhs} >>= {rhs}", params
+        return "%s >>= %s" % (lhs, rhs), params
 
 
 class NetContained(Lookup):
     lookup_name = "net_contained"
 
-    def as_sql(self, compiler, connection):
-        lhs, lhs_params = self.process_lhs(compiler, connection)
-        rhs, rhs_params = self.process_rhs(compiler, connection)
+    def as_sql(self, qn, connection):
+        lhs, lhs_params = self.process_lhs(qn, connection)
+        rhs, rhs_params = self.process_rhs(qn, connection)
         params = lhs_params + rhs_params
-        return f"{lhs} << {rhs}", params
+        return "%s << %s" % (lhs, rhs), params
 
 
 class NetContainedOrEqual(Lookup):
     lookup_name = "net_contained_or_equal"
 
-    def as_sql(self, compiler, connection):
-        lhs, lhs_params = self.process_lhs(compiler, connection)
-        rhs, rhs_params = self.process_rhs(compiler, connection)
+    def as_sql(self, qn, connection):
+        lhs, lhs_params = self.process_lhs(qn, connection)
+        rhs, rhs_params = self.process_rhs(qn, connection)
         params = lhs_params + rhs_params
-        return f"{lhs} <<= {rhs}", params
+        return "%s <<= %s" % (lhs, rhs), params
 
 
 class NetOverlap(Lookup):
     lookup_name = "net_overlap"
 
-    def as_sql(self, compiler, connection):
-        lhs, lhs_params = self.process_lhs(compiler, connection)
-        rhs, rhs_params = self.process_rhs(compiler, connection)
+    def as_sql(self, qn, connection):
+        lhs, lhs_params = self.process_lhs(qn, connection)
+        rhs, rhs_params = self.process_rhs(qn, connection)
         params = lhs_params + rhs_params
-        return f"{lhs} && {rhs}", params
+        return "%s && %s" % (lhs, rhs), params
 
 
 class NetworkFormField(forms.Field):
@@ -118,6 +118,7 @@ class NetMaskLength(Transform):
     function = "MASKLEN"
     lookup_name = "net_mask_length"
 
+    @property
     def output_field(self):
         return IntegerField()
 

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/fields/rfc2317.py

@@ -18,8 +18,8 @@ class RFC2317NetworkFormField(forms.Field):
         if isinstance(value, IPNetwork):
             if value.version == 4 and value.prefixlen > 24:
                 return value
-
-            raise ValidationError(INVALID_RFC2317)
+            else:
+                raise ValidationError(INVALID_RFC2317)
 
         if len(value.split("/")) != 2:
             raise ValidationError("Please specify the prefix length")

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/filtersets/view.py

@@ -9,7 +9,7 @@ from netbox_dns.models import View
 class ViewFilterSet(NetBoxModelFilterSet, TenancyFilterSet):
     class Meta:
         model = View
-        fields = ("id", "name", "default_view", "description")
+        fields = ("id", "name", "description")
 
     def search(self, queryset, name, value):
         if not value.strip():

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/filtersets/zone.py

@@ -31,14 +31,14 @@ class ZoneFilterSet(TenancyFilterSet, NetBoxModelFilterSet):
         to_field_name="name",
         label="View",
     )
-    # DEPRECATED: Remove in 1.1
+    # DEPRECATED: Remove in 1.0
     name_server_id = django_filters.ModelMultipleChoiceFilter(
         queryset=NameServer.objects.all(),
         field_name="nameservers",
         to_field_name="id",
         label="Nameserver IDs",
     )
-    # DEPRECATED: Remove in 1.1
+    # DEPRECATED: Remove in 1.0
     name_server = django_filters.ModelMultipleChoiceFilter(
         queryset=NameServer.objects.all(),
         field_name="nameservers__name",
@@ -59,13 +59,13 @@ class ZoneFilterSet(TenancyFilterSet, NetBoxModelFilterSet):
     )
     soa_mname_id = django_filters.ModelMultipleChoiceFilter(
         queryset=NameServer.objects.all(),
-        label="SOA MName ID",
+        label="SOA MNname ID",
     )
     soa_mname = django_filters.ModelMultipleChoiceFilter(
         queryset=NameServer.objects.all(),
         field_name="soa_mname__name",
         to_field_name="name",
-        label="SOA MName",
+        label="SOA MNname",
     )
     arpa_network = MultiValueCharFilter(
         method="filter_arpa_network",

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/forms/record.py

@@ -28,30 +28,10 @@ class RecordForm(TenancyForm, NetBoxModelForm):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-        initial_zone_id = self.initial.get("zone")
-        if initial_zone_id is not None:
-            self.initial["view"] = Zone.objects.get(pk=initial_zone_id).view
-        else:
-            self.initial["view"] = View.get_default_view()
-
         initial_name = self.initial.get("name")
         if initial_name:
             self.initial["name"] = name_to_unicode(initial_name)
 
-    view = DynamicModelChoiceField(
-        queryset=View.objects.all(),
-        required=False,
-        label="View",
-    )
-    zone = DynamicModelChoiceField(
-        queryset=Zone.objects.all(),
-        required=True,
-        query_params={
-            "view_id": "$view",
-        },
-        label="Zone",
-    )
-
     disable_ptr = forms.BooleanField(
         label="Disable PTR",
         required=False,
@@ -64,7 +44,6 @@ class RecordForm(TenancyForm, NetBoxModelForm):
     fieldsets = (
         FieldSet(
             "name",
-            "view",
             "zone",
             "type",
             "value",
@@ -105,7 +84,6 @@ class RecordFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
             "fqdn",
             "type",
             "value",
-            "disable_ptr",
             "status",
             "description",
             name="Attributes",
@@ -127,10 +105,6 @@ class RecordFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     value = forms.CharField(
         required=False,
     )
-    disable_ptr = forms.NullBooleanField(
-        required=False,
-        label="Disable PTR",
-    )
     status = forms.MultipleChoiceField(
         choices=RecordStatusChoices,
         required=False,
@@ -157,12 +131,10 @@ class RecordImportForm(NetBoxModelImportForm):
             except forms.ValidationError:
                 pass
 
-        if view is not None:
+        if view:
             self.fields["zone"].queryset = Zone.objects.filter(view=view)
         else:
-            self.fields["zone"].queryset = Zone.objects.filter(
-                view=View.get_default_view()
-            )
+            self.fields["zone"].queryset = Zone.objects.filter(view__isnull=True)
 
     zone = CSVModelChoiceField(
         queryset=Zone.objects.all(),

{netbox_plugin_dns-1.0.0 → netbox_plugin_dns-1.0b1}/netbox_dns/forms/view.py

@@ -20,29 +20,26 @@ from netbox_dns.models import View
 
 class ViewForm(TenancyForm, NetBoxModelForm):
     fieldsets = (
-        FieldSet("name", "default_view", "description", "tags", name="View"),
+        FieldSet("name", "description", "tags", name="View"),
         FieldSet("tenant_group", "tenant", name="Tenancy"),
     )
 
     class Meta:
         model = View
-        fields = ("name", "default_view", "description", "tags", "tenant")
+        fields = ("name", "description", "tags", "tenant")
 
 
 class ViewFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     model = View
     fieldsets = (
         FieldSet("q", "filter_id", "tag"),
-        FieldSet("name", "default_view", "description", name="Attributes"),
+        FieldSet("name", "description", name="Attributes"),
         FieldSet("tenant_group_id", "tenant_id", name="Tenancy"),
     )
 
     name = forms.CharField(
         required=False,
     )
-    default_view = forms.NullBooleanField(
-        required=False,
-    )
     description = forms.CharField(
         required=False,
     )