netbox-nso-plugin 0.2.0__tar.gz

netbox_nso_plugin-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. Please also get an in-depth
+      understanding of the Apache License by reading the FAQ at
+      <http://www.apache.org/foundation/license-faq.html>
+
+   Copyright 2025 Marcin Zieba
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_nso_plugin-0.2.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: netbox-nso-plugin
+Version: 0.2.0
+Summary: NetBox plugin integrating NetBox with Cisco NSO via the nso-adapter REST API
+Author: Marcin Zieba
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/marcinpsk/netbox-nso-plugin
+Project-URL: Issues, https://github.com/marcinpsk/netbox-nso-plugin/issues
+Keywords: netbox,plugin,nso,cisco,automation,networking
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Framework :: Django
+Classifier: Environment :: Plugins
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32
+Dynamic: license-file
+
+# netbox-nso-plugin
+
+NetBox 4.6 plugin that integrates NetBox with Cisco NSO via the **nso-adapter** REST API —
+a bidirectional sync: device state is imported into NetBox, and operator-accepted values
+become intent that is applied back to the device through NSO (reconcile-mode commits).
+
+## Features
+
+- Mark NetBox devices as NSO-managed and choose the managed scopes (interfaces, routing,
+  VLANs/L2, SNMP, logging, …) per device.
+- Device **NSO tab**: counts-first category summaries with lazy row expansion, a merged
+  per-interface table (enabled / description / IPs / MTU / switchport), pagination +
+  search, and inline editing of operator-owned values.
+- **Read mirrors** for: interface attributes/IPs/MTU, VLAN database, switchport, SVI/IRB,
+  dot1q subinterfaces, L2 services (epipe/vpls SAPs), LACP/LAG, IS-IS (incl. levels,
+  segment-routing, Flex-Algo), OSPF, BGP (peers/AFs/templates), route policies,
+  redistribution, static routes, BFD, SNMP (secret-safe), logging hosts — materialised
+  into native NetBox / netbox-routing objects with `NSO*State` status overlays and
+  clobber-safe 3-way merge.
+- **Accept → Apply** write path: Accept promotes a value to NetBox-owned intent; one
+  device Apply commits all pending scopes via the NSO `*-reconciler` services, with a
+  two-panel preview (intent summary + native device diff). Greenfield writes for
+  operator-created routes, VLANs, policies, SVIs, subinterfaces and more.
+- Drift handling: value-aware drift display, plus intent **split-brain detection**
+  (orphaned and partial) with one-click re-sync of the adapter intent mirror — never
+  touches the device.
+- Adapter actions from the tab: **Sync**, **Detect drift**, **Test connection**,
+  **Apply**, with job polling.
+- Device onboarding NetBox → NSO (create node, fetch host keys, sync-from) from the
+  NSO Devices dashboard.
+- Exposes `NSODeviceManagement` at `/api/plugins/nso/device-management/` for the
+  adapter's self-healing reconcile path.
+
+## Requirements
+
+- NetBox ≥ 4.6.0
+- Python ≥ 3.12
+
+## Installation
+
+```bash
+pip install netbox-nso-plugin
+```
+
+Add to `PLUGINS` in `configuration.py`:
+
+```python
+PLUGINS = ["netbox_nso_plugin"]
+PLUGINS_CONFIG = {
+    "netbox_nso_plugin": {
+        "adapter_url": "https://nso-adapter.example.net",
+        "adapter_token": "<bearer token>",
+    }
+}
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate netbox_nso_plugin
+```
+
+## Development
+
+See `.devcontainer/` for the Docker-based development environment.

netbox_nso_plugin-0.2.0/README.md

@@ -0,0 +1,65 @@
+# netbox-nso-plugin
+
+NetBox 4.6 plugin that integrates NetBox with Cisco NSO via the **nso-adapter** REST API —
+a bidirectional sync: device state is imported into NetBox, and operator-accepted values
+become intent that is applied back to the device through NSO (reconcile-mode commits).
+
+## Features
+
+- Mark NetBox devices as NSO-managed and choose the managed scopes (interfaces, routing,
+  VLANs/L2, SNMP, logging, …) per device.
+- Device **NSO tab**: counts-first category summaries with lazy row expansion, a merged
+  per-interface table (enabled / description / IPs / MTU / switchport), pagination +
+  search, and inline editing of operator-owned values.
+- **Read mirrors** for: interface attributes/IPs/MTU, VLAN database, switchport, SVI/IRB,
+  dot1q subinterfaces, L2 services (epipe/vpls SAPs), LACP/LAG, IS-IS (incl. levels,
+  segment-routing, Flex-Algo), OSPF, BGP (peers/AFs/templates), route policies,
+  redistribution, static routes, BFD, SNMP (secret-safe), logging hosts — materialised
+  into native NetBox / netbox-routing objects with `NSO*State` status overlays and
+  clobber-safe 3-way merge.
+- **Accept → Apply** write path: Accept promotes a value to NetBox-owned intent; one
+  device Apply commits all pending scopes via the NSO `*-reconciler` services, with a
+  two-panel preview (intent summary + native device diff). Greenfield writes for
+  operator-created routes, VLANs, policies, SVIs, subinterfaces and more.
+- Drift handling: value-aware drift display, plus intent **split-brain detection**
+  (orphaned and partial) with one-click re-sync of the adapter intent mirror — never
+  touches the device.
+- Adapter actions from the tab: **Sync**, **Detect drift**, **Test connection**,
+  **Apply**, with job polling.
+- Device onboarding NetBox → NSO (create node, fetch host keys, sync-from) from the
+  NSO Devices dashboard.
+- Exposes `NSODeviceManagement` at `/api/plugins/nso/device-management/` for the
+  adapter's self-healing reconcile path.
+
+## Requirements
+
+- NetBox ≥ 4.6.0
+- Python ≥ 3.12
+
+## Installation
+
+```bash
+pip install netbox-nso-plugin
+```
+
+Add to `PLUGINS` in `configuration.py`:
+
+```python
+PLUGINS = ["netbox_nso_plugin"]
+PLUGINS_CONFIG = {
+    "netbox_nso_plugin": {
+        "adapter_url": "https://nso-adapter.example.net",
+        "adapter_token": "<bearer token>",
+    }
+}
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate netbox_nso_plugin
+```
+
+## Development
+
+See `.devcontainer/` for the Docker-based development environment.

netbox_nso_plugin-0.2.0/netbox_nso_plugin/__init__.py

@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (C) 2025 Marcin Zieba <marcinpsk@gmail.com>
+from netbox.plugins import PluginConfig
+
+__version__ = "0.2.0"
+
+
+class NSOPluginConfig(PluginConfig):
+    """NetBox plugin configuration for NSO integration."""
+
+    name = "netbox_nso_plugin"
+    verbose_name = "NSO Plugin"
+    description = "Integrates NetBox with Cisco NSO via the nso-adapter REST API."
+    version = __version__
+    base_url = "nso"
+    min_version = "4.6.0"
+    required_settings = []
+    default_settings = {
+        "adapter_url": "",
+        "adapter_token": "",
+        # A 'deploying' row that outlives a SUCCEEDED apply by this long without the
+        # device ever showing its value escalates to apply_failed (silent drop, #26).
+        "stuck_deploying_grace_minutes": 10,
+    }
+    author = "Marcin Zieba"
+    author_email = "marcinpsk@gmail.com"
+
+    def ready(self):  # pragma: no cover
+        """Connect signal handlers after all apps are loaded."""
+        super().ready()
+        from . import (
+            jobs,  # noqa: F401 — registers the @system_job hourly onboarding sweep
+            signals,  # noqa: F401
+        )
+        from .signals import _connect_g_activated
+
+        _connect_g_activated()
+
+        # Register the shared-object materialization specs (route-policy families) at startup.
+        # They live in route_policy_reconciler (run via its module-level _register_specs()), but
+        # that module was previously imported only lazily during a reconcile — so a web worker
+        # rendering the versions page before any reconcile had an EMPTY registry, making
+        # hash_captured() return "" and every device version falsely read as "matches". Importing
+        # it here guarantees the specs exist in every process (web + worker).
+        from django.conf import settings
+
+        from . import route_policy_reconciler  # noqa: F401
+        from .derived_intent import _register_description_from_cable
+
+        # The field is always available; enabled templates are read live from NetBox.
+        _register_description_from_cable()
+
+        cfg = settings.PLUGINS_CONFIG.get("netbox_nso_plugin", {})
+        self._interface_ip_auto_create = cfg.get("interface_ip_auto_create", False)
+        self._static_route_auto_create = cfg.get("static_route_auto_create", False)
+        # Link-role resolver: opt-in fallback to M13's classify_interface heuristic
+        # when an interface has no explicit NSOLinkRoleAssignment (default off).
+        self._link_role_derived_fallback = cfg.get("link_role_derived_fallback", False)
+
+
+config = NSOPluginConfig