diff --git a/README.md b/README.md index d4ecb91..60832ec 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ The Netbox DNS Bridge plugin implements a lightweight DNS server inside Netbox a for BIND and other DNS Servers implementing RFC9432 to retrieve DNS Zones directly from Netbox using DNS native mechanisms. -PyPi +PyPi Stars Badge Forks Badge Issues Badge @@ -13,9 +13,9 @@ using DNS native mechanisms. GitHub contributors License Badge Code Style Black -Downloads -Downloads/Week -Downloads/Month +Downloads +Downloads/Week +Downloads/Month @@ -59,28 +59,36 @@ tsig_keys | Maps a TSIG Key to be used for each view. This plugin is an extension to the netbox-plugin-dns plugin. As such the versioning of this plugin was changed to match the one of the netbox-plugin-dns plugin closely. To guarantee compatability, ensure that the major and minor version match between both plugins. -For example, when using netbox-plugin-dns `v1.5.5` install netbox-plugin-dns-bridge `v1.5.x` +For example, when using netbox-plugin-dns `v1.5.5` install netbox-plugin-dns-bridge `v1.5.x`. ## Post 1.0.7 Upgrade Guide -After version 1.0.7, the project was restructured and renamed. Until that point version updates happened more or less -automatically. However, this shift is more of a move from one plugin to another as the package name has changed. +Applies only if you have a <= 1.0.7 installation. If you are freshly installing this plugin, +go on to [Installation guide](installation-guide). -This should not be an issue since the slave DNS Servers connected to Netbox can operate independently while this plugin -is being upgraded. +After version 1.0.7, the project was restructured and renamed. Until that point version updates +happened more or less automatically. However, this shift is more of a move from one plugin to +another as the package name has changed. -Make sure to note down the catalog zone serial number before switching. +This should not be an issue since the slave DNS Servers connected to Netbox can operate +independently while this plugin is being upgraded. + +Make sure to note down the catalog zone serial number before going further. 1. Remove Netbox Bind Provisioner package - Remove `netbox-plugin-bind-provisioner` from **local_dependencies.txt** - Uninstall the package: `pip uninstall netbox-plugin-bind-provisioner` 2. Install Netbox DNS Bridge package - Install the package `pip install netbox-plugin-dns-bridge` - - Put `netbox-plugin-dns-bridge` in your **local_dependencies.txt** so it will be installed on next upgrade. -3. Follow the Installation Guide below. + - Put `netbox-plugin-dns-bridge` in your **local_dependencies.txt** so it will be installed on + next upgrade. +3. Adjust your `configuration.py` + - Change the plugin name from `netbox-plugin-bind-provisioner` to `netbox-plugin-dns-bridge` + - Change the key in `PLUGIN_CONFIG` from `netbox_plugin_bind_provisioner` to `netbox_dns_bridge` 4. Ensure the `dns-transfer-endpoint` service is not running before the next step. 5. Restore the catalog zone serial you noted down previously so that your slave dns servers continue to pull the changes: `manage.py dns-settings set catalog-zone-soa-serial yourserialnumber` -6. Start the `dns-transfer-endpoint` service. This should be it. +6. Start the `dns-transfer-endpoint` service. +7. Mission accomplished. ## Installation guide This setup provisions a BIND9 server directly with DNS data from NetBox. BIND9 can optionally run on @@ -103,7 +111,7 @@ This guide assumes: 2. Adding required package ``` cd netbox - echo netbox-plugin-bind-provisioner >> local_requirements.txt + echo netbox-plugin-dns-bridge >> local_requirements.txt . venv/bin/activate pip install -r local_requirements.txt ``` diff --git a/netbox_dns_bridge/__init__.py b/netbox_dns_bridge/__init__.py index b95c1a4..508846e 100644 --- a/netbox_dns_bridge/__init__.py +++ b/netbox_dns_bridge/__init__.py @@ -2,7 +2,7 @@ import logging from netbox.plugins import PluginConfig from django.conf import settings -__version__ = "1.5.0" +__version__ = "1.5.1" logger = logging.getLogger(__name__) diff --git a/pyproject.toml b/pyproject.toml index 898dee3..7e6ebb5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,7 +9,7 @@ description = "A bridge between netbox-plugin-dns and your DNS infrastructure." authors = [ { name = "Sven Luethi" }, ] -license = { text = "GPL-2.0" } +license = { file = "LICENSE.md" } readme = "README.md" requires-python = ">=3.7" dependencies = [