Merge pull request #35 from netboxlabs/develop

🚚 release

Author: mfiedorowicz

Makefile

@@ -14,10 +14,10 @@ docker-compose-netbox-plugin-down:
 
 .PHONY: docker-compose-netbox-plugin-test
 docker-compose-netbox-plugin-test:
-	-@$(DOCKER_COMPOSE) -f docker/docker-compose.yaml run -u root --rm netbox ./manage.py test --keepdb netbox_diode_plugin
+	-@$(DOCKER_COMPOSE) -f docker/docker-compose.yaml -f docker/docker-compose.test.yaml run -u root --rm netbox ./manage.py test --keepdb netbox_diode_plugin
 	@$(MAKE) docker-compose-netbox-plugin-down
 
 .PHONY: docker-compose-netbox-plugin-test-cover
 docker-compose-netbox-plugin-test-cover:
-	-@$(DOCKER_COMPOSE) -f docker/docker-compose.yaml run --rm -u root -e COVERAGE_FILE=/opt/netbox/netbox/coverage/.coverage netbox sh -c "coverage run --source=netbox_diode_plugin ./manage.py test --keepdb netbox_diode_plugin && coverage xml -o /opt/netbox/netbox/coverage/report.xml && coverage report -m | tee /opt/netbox/netbox/coverage/report.txt"
+	-@$(DOCKER_COMPOSE) -f docker/docker-compose.yaml -f docker/docker-compose.test.yaml run --rm -u root -e COVERAGE_FILE=/opt/netbox/netbox/coverage/.coverage netbox sh -c "coverage run --source=netbox_diode_plugin --omit=*_pb2*,*/migrations/* ./manage.py test --keepdb netbox_diode_plugin && coverage xml -o /opt/netbox/netbox/coverage/report.xml && coverage report -m | tee /opt/netbox/netbox/coverage/report.txt"
 	@$(MAKE) docker-compose-netbox-plugin-down

README.md

@@ -40,6 +40,30 @@ PLUGINS = [
 ]
 ```
 
+Also in your `configuration.py` file, in order to customise the plugin settings, add `netbox_diode_plugin`to the
+`PLUGINS_CONFIG` dictionary, e.g.:
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_diode_plugin": {
+        # Diode gRPC target for communication with Diode server
+        "diode_target_override": "grpc://localhost:8080/diode",
+
+        # User allowed for Diode to NetBox communication
+        "diode_to_netbox_username": "diode-to-netbox",
+
+        # User allowed for NetBox to Diode communication
+        "netbox_to_diode_username": "netbox-to-diode",
+
+        # # User allowed for data ingestion
+        "diode_username": "diode-ingestion",
+    },
+}
+```
+
+Note: Once you customise usernames with PLUGINS_CONFIG during first installation, you should not change or remove them
+later on. Doing so will cause the plugin to stop working properly.
+
 Restart NetBox services to load the plugin:
 
 ```

docker/Dockerfile-diode-netbox-plugin

@@ -1,4 +1,4 @@
-FROM netboxcommunity/netbox:v4.1-beta1-2.9.1
+FROM netboxcommunity/netbox:v4.1-3.0.1
 
 COPY ./netbox/configuration/ /etc/netbox/config/
 RUN chmod 755 /etc/netbox/config/* && \

docker/docker-compose.test.yaml

@@ -0,0 +1,5 @@
+name: diode-netbox-plugin
+services:
+  netbox:
+    volumes:
+      - ./netbox/plugins_test.py:/etc/netbox/config/plugins.py:z,ro

docker/docker-compose.yaml

@@ -1,7 +1,7 @@
 name: diode-netbox-plugin
 services:
-  netbox: &netbox
-    image: netboxcommunity/netbox:v4.1-beta1-2.9.1-diode-netbox-plugin
+  netbox:
+    image: netboxcommunity/netbox:v4.1-3.0.1-diode-netbox-plugin
     build:
       context: .
       dockerfile: Dockerfile-diode-netbox-plugin

docker/netbox/configuration/plugins.py

@@ -8,6 +8,16 @@
 
 # PLUGINS_CONFIG = {
 #     "netbox_diode_plugin": {
+#         # Diode gRPC target for communication with Diode server
+#         "diode_target_override": "grpc://localhost:8080/diode",
 #
-#     }
+#         # User allowed for Diode to NetBox communication
+#         "diode_to_netbox_username": "diode-to-netbox",
+#
+#         # User allowed for NetBox to Diode communication
+#         "netbox_to_diode_username": "netbox-to-diode",
+#
+#         # User allowed for data ingestion
+#         "diode_username": "diode-ingestion",
+#     },
 # }

docker/netbox/launch-netbox.sh

@@ -46,10 +46,10 @@ load_configuration() {
 
 reload_netbox() {
   if [ "$RELOAD_NETBOX_ON_DIODE_PLUGIN_CHANGE" == "true" ]; then
-    netbox_diode_plugin_md5=$(find /opt/netbox/netbox/netbox_diode_plugin -type f -name "*.py" -exec md5sum {} + | md5sum | awk '{print $1}')
+    netbox_diode_plugin_md5=$(find /opt/netbox/netbox/netbox_diode_plugin -type f \( -name "*.py" -o -name "*.html" \) -exec md5sum {} + | md5sum | awk '{print $1}')
 
     while true; do
-      new_md5=$(find /opt/netbox/netbox/netbox_diode_plugin -type f -name "*.py" -exec md5sum {} + | md5sum | awk '{print $1}')
+      new_md5=$(find /opt/netbox/netbox/netbox_diode_plugin -type f \( -name "*.py" -o -name "*.html" \) -exec md5sum {} + | md5sum | awk '{print $1}')
       if [ "$netbox_diode_plugin_md5" != "$new_md5" ]; then
         echo "🔄 Reloading NetBox"
         curl --silent --output /dev/null --unix-socket /opt/unit/unit.sock -X GET http://localhost/control/applications/netbox/restart

docker/netbox/plugins_test.py

@@ -0,0 +1,13 @@
+# Add your plugins and plugin settings here.
+# Of course uncomment this file out.
+
+# To learn how to build images with your required plugins
+# See https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins
+
+PLUGINS = ["netbox_diode_plugin"]
+
+PLUGINS_CONFIG = {
+    "netbox_diode_plugin": {
+        "enable_ingestion_logs": True,
+    }
+}

docker/requirements-diode-netbox-plugin.txt

@@ -1,3 +1,6 @@
-pytest==8.0.2
-grpcio==1.62.1
+Brotli==1.1.0
+certifi==2024.7.4
 coverage==7.6.0
+grpcio==1.62.1
+protobuf==5.28.1
+pytest==8.0.2

netbox_diode_plugin/__init__.py

@@ -16,6 +16,19 @@ class NetBoxDiodePluginConfig(PluginConfig):
     version = version_semver()
     base_url = "diode"
     min_version = "3.7.2"
+    default_settings = {
+        # Default Diode gRPC target for communication with Diode server
+        "diode_target": "grpc://localhost:8080/diode",
+
+        # User allowed for Diode to NetBox communication
+        "diode_to_netbox_username": "diode-to-netbox",
+
+        # User allowed for NetBox to Diode communication
+        "netbox_to_diode_username": "netbox-to-diode",
+
+        # User allowed for data ingestion
+        "diode_username": "diode-ingestion",
+    }
 
 
 config = NetBoxDiodePluginConfig