netbox-plugin-dns 0.22.9__tar.gz → 1.0.0__tar.gz

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-plugin-dns
-Version: 0.22.9
+Version: 1.0.0
 Summary: NetBox DNS is a NetBox plugin for managing DNS data.
 Home-page: https://github.com/peteeckel/netbox-plugin-dns
 License: MIT
@@ -21,7 +21,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, current and conforming 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, up-to-date and compliant with 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,21 +36,35 @@ 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>
 
-## Features
+## Objectives
+NetBox DNS is designed to be the 'DNS Source of Truth' analogous to NetBox being the 'Network Source of Truth'.
 
-* 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 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.
 
-NetBox DNS is using the standardized NetBox plugin interface, so it also takes advantage of the NetBox tagging and change log features.
+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.
 
 ## Requirements
 
-* NetBox 3.5.0 or higher
-* Python 3.8 or higher
+* NetBox 4.0.0 or higher
+* Python 3.10 or higher
 
 ## Installation & Configuration
 
@@ -87,7 +101,7 @@ Full documentation on using plugins with NetBox: [Using Plugins - NetBox Documen
 
 ## Contribute
 
-Contributions are always welcome! Please see: [contributing guide](CONTRIBUTING.md)
+Contributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)
 
 ## Documentation
 

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0.0}/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, current and conforming 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, up-to-date and compliant with 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,21 +14,35 @@ 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>
 
-## Features
+## Objectives
+NetBox DNS is designed to be the 'DNS Source of Truth' analogous to NetBox being the 'Network Source of Truth'.
 
-* 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 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.
 
-NetBox DNS is using the standardized NetBox plugin interface, so it also takes advantage of the NetBox tagging and change log features.
+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.
 
 ## Requirements
 
-* NetBox 3.5.0 or higher
-* Python 3.8 or higher
+* NetBox 4.0.0 or higher
+* Python 3.10 or higher
 
 ## Installation & Configuration
 
@@ -65,7 +79,7 @@ Full documentation on using plugins with NetBox: [Using Plugins - NetBox Documen
 
 ## Contribute
 
-Contributions are always welcome! Please see: [contributing guide](CONTRIBUTING.md)
+Contributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)
 
 ## Documentation
 

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0.0}/netbox_dns/__init__.py

@@ -1,31 +1,20 @@
-import sys
+from netbox.plugins import PluginConfig
 
-from extras.plugins import PluginConfig
-from django.db.utils import OperationalError
-
-try:
-    # NetBox 3.5.0 - 3.5.7, 3.5.9+
-    from extras.plugins import get_plugin_config
-except ImportError:
-    # NetBox 3.5.8
-    from extras.plugins.utils import get_plugin_config
-
-__version__ = "0.22.9"
+__version__ = "1.0.0"
 
 
 class DNSConfig(PluginConfig):
     name = "netbox_dns"
     verbose_name = "NetBox DNS"
     description = "NetBox plugin for DNS data"
-    min_version = "3.5.0"
-    max_version = "3.99.0"
+    min_version = "4.0.0"
     version = __version__
     author = "Peter Eckel"
     author_email = "pete@netbox-dns.org"
     required_settings = []
     default_settings = {
         "zone_default_ttl": 86400,
-        "zone_soa_serial_auto": True,
+        "zone_soa_ttl": 86400,
         "zone_soa_serial": 1,
         "zone_soa_refresh": 43200,
         "zone_soa_retry": 7200,

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0.0}/netbox_dns/api/nested_serializers.py

@@ -2,25 +2,10 @@ from rest_framework import serializers
 
 from netbox.api.serializers import WritableNestedSerializer
 
-from netbox_dns.models import View, Zone, NameServer, Record, Registrar, Contact
+from netbox_dns.models import Zone, Record
+from netbox_dns.api.serializers_.view import ViewSerializer
 
 
-#
-# Views
-#
-class NestedViewSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:view-detail"
-    )
-
-    class Meta:
-        model = View
-        fields = ["id", "url", "display", "name"]
-
-
-#
-# Zones
-#
 class NestedZoneSerializer(WritableNestedSerializer):
     def to_representation(self, instance):
         # +
@@ -39,7 +24,8 @@ class NestedZoneSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:zone-detail"
     )
-    view = NestedViewSerializer(
+    view = ViewSerializer(
+        nested=True,
         many=False,
         required=False,
         read_only=True,
@@ -65,22 +51,6 @@ class NestedZoneSerializer(WritableNestedSerializer):
         ]
 
 
-#
-# Nameservers
-#
-class NestedNameServerSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:nameserver-detail"
-    )
-
-    class Meta:
-        model = NameServer
-        fields = ["id", "url", "display", "name"]
-
-
-#
-# Records
-#
 class NestedRecordSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:record-detail"
@@ -110,29 +80,3 @@ class NestedRecordSerializer(WritableNestedSerializer):
             "zone",
             "active",
         ]
-
-
-#
-# Registrars
-#
-class NestedRegistrarSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:registrar-detail"
-    )
-
-    class Meta:
-        model = Registrar
-        fields = ["display", "id", "url", "name", "iana_id"]
-
-
-#
-# Contacts
-#
-class NestedContactSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:contact-detail"
-    )
-
-    class Meta:
-        model = Contact
-        fields = ["display", "id", "url", "name", "contact_id"]

netbox_plugin_dns-1.0.0/netbox_dns/api/serializers.py

@@ -0,0 +1,8 @@
+from .serializers_.contact import *
+from .serializers_.nameserver import *
+from .serializers_.record import *
+from .serializers_.registrar import *
+from .serializers_.view import *
+from .serializers_.zone import *
+
+from .nested_serializers import *

netbox_plugin_dns-1.0.0/netbox_dns/api/serializers_/contact.py

@@ -0,0 +1,37 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_dns.models import Contact
+
+
+class ContactSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:contact-detail"
+    )
+
+    class Meta:
+        model = Contact
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "contact_id",
+            "organization",
+            "street",
+            "city",
+            "state_province",
+            "postal_code",
+            "country",
+            "phone",
+            "phone_ext",
+            "fax",
+            "fax_ext",
+            "email",
+            "created",
+            "last_updated",
+            "custom_fields",
+        )
+        brief_fields = ("id", "url", "display", "name", "description", "contact_id")

netbox_plugin_dns-1.0.0/netbox_dns/api/serializers_/nameserver.py

@@ -0,0 +1,39 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.models import NameServer
+
+from netbox_dns.api.nested_serializers import NestedZoneSerializer
+
+
+class NameServerSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:nameserver-detail"
+    )
+    zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text="Zones served by the authoritative nameserver",
+    )
+    tenant = TenantSerializer(required=False, allow_null=True)
+
+    class Meta:
+        model = NameServer
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "tags",
+            "zones",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+        brief_fields = ("id", "url", "display", "name", "description")

netbox_plugin_dns-1.0.0/netbox_dns/api/serializers_/record.py

@@ -0,0 +1,90 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from ipam.api.serializers import IPAddressSerializer
+from tenancy.api.serializers import TenantSerializer
+
+from netbox_dns.models import Record
+from netbox_dns.api.nested_serializers import (
+    NestedZoneSerializer,
+    NestedRecordSerializer,
+)
+
+
+class RecordSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:record-detail"
+    )
+    ptr_record = NestedRecordSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="PTR record generated from an address",
+    )
+    address_record = NestedRecordSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="Address record defining the PTR",
+    )
+    zone = NestedZoneSerializer(
+        many=False,
+        required=False,
+        help_text="Zone the record belongs to",
+    )
+    active = serializers.BooleanField(
+        required=False,
+        read_only=True,
+    )
+    ipam_ip_address = IPAddressSerializer(
+        nested=True,
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="IPAddress linked to the record",
+    )
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = Record
+        fields = (
+            "id",
+            "url",
+            "zone",
+            "display",
+            "type",
+            "name",
+            "fqdn",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "tags",
+            "created",
+            "last_updated",
+            "managed",
+            "disable_ptr",
+            "ptr_record",
+            "address_record",
+            "active",
+            "custom_fields",
+            "tenant",
+            "ipam_ip_address",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "zone",
+            "display",
+            "type",
+            "name",
+            "fqdn",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "active",
+        )

netbox_plugin_dns-1.0.0/netbox_dns/api/serializers_/registrar.py

@@ -0,0 +1,31 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_dns.models import Registrar
+
+
+class RegistrarSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:registrar-detail"
+    )
+
+    class Meta:
+        model = Registrar
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "iana_id",
+            "address",
+            "referral_url",
+            "whois_server",
+            "abuse_email",
+            "abuse_phone",
+            "created",
+            "last_updated",
+            "custom_fields",
+        )
+        brief_fields = ("id", "url", "display", "name", "description", "iana_id")

netbox_plugin_dns-1.0.0/netbox_dns/api/serializers_/view.py

@@ -0,0 +1,34 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.models import View
+
+
+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:
+        model = View
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "default_view",
+            "tags",
+            "description",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+        brief_fields = ("id", "url", "display", "name", "default_view", "description")

netbox_plugin_dns-1.0.0/netbox_dns/api/serializers_/zone.py

@@ -0,0 +1,159 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.api.serializers_.view import ViewSerializer
+from netbox_dns.api.serializers_.nameserver import NameServerSerializer
+from netbox_dns.api.serializers_.registrar import RegistrarSerializer
+from netbox_dns.api.serializers_.contact import ContactSerializer
+from netbox_dns.api.nested_serializers import NestedZoneSerializer
+
+from netbox_dns.models import Zone
+
+
+class ZoneSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:zone-detail"
+    )
+    view = ViewSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        default=None,
+        help_text="View the zone belongs to",
+    )
+    nameservers = NameServerSerializer(
+        nested=True,
+        many=True,
+        read_only=False,
+        required=False,
+        help_text="Nameservers for the zone",
+    )
+    soa_mname = NameServerSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="Primary nameserver for the zone",
+    )
+    rfc2317_parent_zone = NestedZoneSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        help_text="RFC2317 arent zone for the zone",
+    )
+    rfc2317_child_zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        help_text="RFC2317 child zones of the zone",
+    )
+    registrar = RegistrarSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The registrar the domain is registered with",
+    )
+    registrant = ContactSerializer(
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The owner of the domain",
+    )
+    admin_c = ContactSerializer(
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The administrative contact for the domain",
+    )
+    tech_c = ContactSerializer(
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The technical contact for the domain",
+    )
+    billing_c = ContactSerializer(
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The billing contact for the domain",
+    )
+    active = serializers.BooleanField(
+        required=False,
+        read_only=True,
+        allow_null=True,
+    )
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    def create(self, validated_data):
+        nameservers = validated_data.pop("nameservers", None)
+
+        zone = super().create(validated_data)
+
+        if nameservers is not None:
+            zone.nameservers.set(nameservers)
+
+        return zone
+
+    def update(self, instance, validated_data):
+        nameservers = validated_data.pop("nameservers", None)
+
+        zone = super().update(instance, validated_data)
+
+        if nameservers is not None:
+            zone.nameservers.set(nameservers)
+
+        return zone
+
+    class Meta:
+        model = Zone
+        fields = (
+            "id",
+            "url",
+            "name",
+            "view",
+            "display",
+            "nameservers",
+            "status",
+            "description",
+            "tags",
+            "created",
+            "last_updated",
+            "default_ttl",
+            "soa_ttl",
+            "soa_mname",
+            "soa_rname",
+            "soa_serial",
+            "soa_serial_auto",
+            "soa_refresh",
+            "soa_retry",
+            "soa_expire",
+            "soa_minimum",
+            "rfc2317_prefix",
+            "rfc2317_parent_managed",
+            "rfc2317_parent_zone",
+            "rfc2317_child_zones",
+            "registrar",
+            "registry_domain_id",
+            "registrant",
+            "tech_c",
+            "admin_c",
+            "billing_c",
+            "active",
+            "custom_fields",
+            "tenant",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "name",
+            "view",
+            "display",
+            "status",
+            "description",
+            "rfc2317_prefix",
+            "active",
+        )