diff --git a/README.md b/README.md index 7d7fa35..2e7f770 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,27 @@ was changed to match the one of the netbox-plugin-dns plugin closely. To guarant 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` +## 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. + +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 switching. + +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. +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. + ## Installation guide This setup provisions a BIND9 server directly with DNS data from NetBox. BIND9 can optionally run on a separate server. If so, any reference to 127.0.0.1 in step 6 must be replaced with the IP address @@ -227,3 +248,4 @@ This guide assumes: 7. Restart bind - Done +