Initial commit

Author: miaow2

.github/workflows/commit.yaml

@@ -4,18 +4,17 @@ on: [push, pull_request]
 
 jobs:
   lint:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     strategy:
       max-parallel: 10
       matrix:
-        os: [ubuntu-latest]
-        version: ["3.10", "3.11"]
+        python: ["3.10", "3.11"]
     steps:
       - uses: actions/checkout@v3
-      - name: Set up python ${{ matrix.version }}
+      - name: Set up python ${{ matrix.python }}
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.version }}
+          python-version: ${{ matrix.python }}
       - name: Setup dev env
         run: |
           python -m pip install --upgrade pip

MANIFEST.in

@@ -8,3 +8,4 @@ recursive-exclude * *.py[co]
 
 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
 recursive-include netbox_config_diff/templates *
+recursive-include netbox_config_diff/static *

README.md

@@ -6,10 +6,9 @@ NetBox plugin for Config Diff.
 * Free software: Apache-2.0
 * Documentation: https://miaow2.github.io/netbox-config-diff/
 
-
 ## Features
 
-The features the plugin provides should be listed here.
+Find diff between configurations rendered in NetBox and actual on the device.
 
 ## Compatibility
 
@@ -35,18 +34,75 @@ git+https://github.com/miaow2/netbox-config-diff
 ```
 
 Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
- or if you use netbox-docker, your `/configuration/plugins.py` file :
+ or if you use netbox-docker, your `/configuration/plugins.py` file,
+ and define credentials for devices connection:
 
 ```python
 PLUGINS = [
-    'netbox_config_diff'
+    "netbox_config_diff",
 ]
 
 PLUGINS_CONFIG = {
-    "netbox_config_diff": {},
+    "netbox_config_diff": {
+        "USERNAME": "foo",
+        "PASSWORD": "bar",
+    },
 }
 ```
 
+Collect static from the plugin:
+
+```bash
+python manage.py collectstatic --noinput
+```
+
+## Usage
+
+Under `Plugins` navbar menu you can find plugin
+
+![Screenshot of navbar](docs/media/screenshots/navbar.png)
+
+Add PlatformSetting objects for your platforms in NetBox.
+
+Define:
+
+- **Driver** for Scrapli, you can find all drivers in [Scrapli](https://github.com/carlmontanari/scrapli) and [Scrapli community](https://github.com/scrapli/scrapli_community) documentation.
+- **Command** to collect configuration
+- Optional regex patterns to exclude from actual config, specify each pattern on a new line
+
+![Screenshot of PlatformSetting](docs/media/screenshots/platformsetting.png)
+
+Plugin adds a custom script `ConfigDiffScript`
+
+![Screenshot of the scripts list](docs/media/screenshots/script-list.png)
+
+In the script, you can define a site, on which devices run compliance, or devices.
+ If you define both fields, script will run only on devices from `Devices` field
+
+> **Warning**
+>
+> Script run only on devices with status `Active`, assigned Primary IP, Platform and PlatformSetting
+
+![Screenshot of the script](docs/media/screenshots/script.png)
+
+After script is done you can find results in `Config Compliances` menu. Each device has its own result.
+
+![Screenshot of the compliance list](docs/media/screenshots/compliance-list.png)
+
+## Examples
+
+Compliance finished with error
+
+![Screenshot of the compliance error](docs/media/screenshots/compliance-error.png)
+
+Render diff between configurations
+
+![Screenshot of diff](docs/media/screenshots/compliance-diff.png)
+
+No diff
+
+![Screenshot of the compliance ok](docs/media/screenshots/compliance-ok.png)
+
 ## Credits
 
 Based on the NetBox plugin tutorial: