netbox-it-landscape 0.2.0__tar.gz

netbox_it_landscape-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Laurent Quastana
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netbox_it_landscape-0.2.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: netbox-it-landscape
+Version: 0.2.0
+Summary: NetBox plugin for application landscape mapping, KPIs, facility comparison, and sector setup bundles
+Author: Laurent Quastana
+License-Expression: MIT
+Project-URL: Source, https://github.com/lquastana/netbox-it-landscape
+Keywords: netbox,netbox-plugin,cartography,application-landscape
+Classifier: Framework :: Django
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# netbox-it-landscape
+
+🇫🇷 [Version française](README.fr.md)
+
+NetBox plugin for **application landscape cartography**, a native integration
+of the [it-landscape](https://github.com/lquastana/it-landscape) project
+features: **business**, **application** and **flow** views — plus KPI
+dashboards, facility comparison and a setup wizard.
+
+## Why a plugin?
+
+The original it-landscape project runs *next to* NetBox (API reads + `app:XXX`
+tags). This plugin moves the cartography *inside* NetBox:
+
+| it-landscape concept | In the plugin |
+|---|---|
+| Facility | **NetBox Site** (native) |
+| Business domain | `BusinessDomain` model (attached to the site) |
+| Process | `BusinessProcess` model |
+| Application (criticality, interfaces…) | `Application` model — **unique in the referential**, attached to N processes |
+| `multiEtablissement` flag | **Derived**: an application linked to processes of several sites is multi-site |
+| Trigram (JSON join key) | **Removed** — replaced by real relations (FK / M2M) |
+| Application flow (protocol, message, EAI…) | `ApplicationFlow` model (with facility FK) |
+| Servers linked by `app:XXX` tag | **Direct M2M relations** to VM / Device |
+
+Native integration benefits: NetBox changelog and journal on every object,
+per-object permissions, global search, REST API + filters, custom fields,
+tags, and contextual panels injected on Site / VM / Device pages.
+
+## Features
+
+- **Business view** (`/plugins/it-landscape/metier/`): facilities → colored
+  domains → processes → application cards with criticality and active
+  interfaces. Detailed mode and condensed, print-friendly **landscape mode**.
+- **Application view** (`/plugins/it-landscape/applicatif/`): referential
+  applications with their servers (VMs/devices), IPs and roles.
+- **Flow view** (`/plugins/it-landscape/cartographie-flux/`): filterable table
+  (facility, interface, protocol, EAI) + source → target SVG diagram colored
+  by interface type.
+- **KPI summary** (`/plugins/it-landscape/synthese/`): key counters, attention
+  points (critical apps without server/monitoring…), EAI dependency, most
+  connected applications, top vendors.
+- **Facility comparison** (`/plugins/it-landscape/comparaison/`): similarity
+  matrix (Jaccard), already-mutualized applications, **convergence
+  opportunities** (same process, different applications), facility-specific
+  applications.
+- **Setup wizard** (`/plugins/it-landscape/initialisation/`): ready-to-use
+  modeling bundles — **Hospital IS (SIH)** (admissions, EHR, pharmacy,
+  imaging… with HL7/DICOM flows through an EAI) and **Manufacturing** (ERP,
+  MES, SCADA, WMS… with OPC-UA/EDI flows through an ESB) — domain/process
+  structure + sample applications, VLANs, VMs and flows, in one click.
+- **Multilingual**: English interface with a full French translation
+  (follows the NetBox user language preference).
+- **Full CRUD**: domains, processes, applications, flows (forms, filters,
+  bulk delete, changelog, journal).
+- **REST API**: `/api/plugins/it-landscape/…` (4 endpoints, filters included).
+- **NetBox global search**: applications, flows, domains, processes indexed.
+- **Contextual panels**: applications shown on VM / Device pages, cartography
+  summary on the Site page.
+- **it-landscape data import**: `import_it_landscape` management command.
+
+## Screenshots
+
+### KPI summary
+
+![KPI summary](docs/screenshots/kpi-summary.png)
+
+### Condensed business landscape
+
+![Business landscape](docs/screenshots/business-landscape.png)
+
+### Application view
+
+![Application view](docs/screenshots/application-view.png)
+
+### Flow view
+
+![Flow view](docs/screenshots/flow-view.png)
+
+### Facility comparison
+
+![Facility comparison](docs/screenshots/facility-comparison.png)
+
+## Installation
+
+```bash
+pip install netbox-it-landscape   # or pip install -e /path/to/the/repo
+```
+
+In `configuration.py` (or `/etc/netbox/config/plugins.py` with netbox-docker):
+
+```python
+PLUGINS = ["netbox_it_landscape"]
+```
+
+Then:
+
+```bash
+python manage.py migrate
+```
+
+### Development with the it-landscape Docker stack
+
+The `docker-compose.override.yml` file provided in the it-landscape repository
+mounts this plugin into the NetBox container, installs it in editable mode and
+enables it. From the it-landscape repository:
+
+```bash
+docker compose --profile netbox up -d --force-recreate netbox
+```
+
+## Importing existing data
+
+The it-landscape project JSON files (`<facility>.json`, `<facility>.flux.json`,
+`<facility>.infra.json`, `trigrammes.json`) can be imported in one command:
+
+```bash
+python manage.py import_it_landscape /opt/it-landscape-data --create-sites --with-infra
+```
+
+- **Sites** are resolved by name (`--create-sites` creates missing ones).
+- Applications are **unified by name**: an application present in several
+  facilities becomes a single multi-site record. Trigrams from the JSON files
+  are only used as a resolution key during import.
+- `--with-infra` also creates the test infrastructure: **VMs** (vCPU, RAM,
+  disk, eth0 interface, primary IP, `app:XXX` tag) from `*.infra.json`,
+  **VLANs, prefixes and gateways** from `*.network.json`.
+- **NetBox VMs** are attached to applications via the `*.infra.json` files.
+- Applications referenced only by flows (EAI, monitoring…) are created in an
+  "Out of business referential" domain.
+- The command is **idempotent** (safe to re-run, no duplicates).
+
+## Compatibility
+
+- NetBox ≥ 4.0 (tested on 4.3)
+- Python ≥ 3.10
+
+## License
+
+MIT

netbox_it_landscape-0.2.0/README.md

@@ -0,0 +1,140 @@
+# netbox-it-landscape
+
+🇫🇷 [Version française](README.fr.md)
+
+NetBox plugin for **application landscape cartography**, a native integration
+of the [it-landscape](https://github.com/lquastana/it-landscape) project
+features: **business**, **application** and **flow** views — plus KPI
+dashboards, facility comparison and a setup wizard.
+
+## Why a plugin?
+
+The original it-landscape project runs *next to* NetBox (API reads + `app:XXX`
+tags). This plugin moves the cartography *inside* NetBox:
+
+| it-landscape concept | In the plugin |
+|---|---|
+| Facility | **NetBox Site** (native) |
+| Business domain | `BusinessDomain` model (attached to the site) |
+| Process | `BusinessProcess` model |
+| Application (criticality, interfaces…) | `Application` model — **unique in the referential**, attached to N processes |
+| `multiEtablissement` flag | **Derived**: an application linked to processes of several sites is multi-site |
+| Trigram (JSON join key) | **Removed** — replaced by real relations (FK / M2M) |
+| Application flow (protocol, message, EAI…) | `ApplicationFlow` model (with facility FK) |
+| Servers linked by `app:XXX` tag | **Direct M2M relations** to VM / Device |
+
+Native integration benefits: NetBox changelog and journal on every object,
+per-object permissions, global search, REST API + filters, custom fields,
+tags, and contextual panels injected on Site / VM / Device pages.
+
+## Features
+
+- **Business view** (`/plugins/it-landscape/metier/`): facilities → colored
+  domains → processes → application cards with criticality and active
+  interfaces. Detailed mode and condensed, print-friendly **landscape mode**.
+- **Application view** (`/plugins/it-landscape/applicatif/`): referential
+  applications with their servers (VMs/devices), IPs and roles.
+- **Flow view** (`/plugins/it-landscape/cartographie-flux/`): filterable table
+  (facility, interface, protocol, EAI) + source → target SVG diagram colored
+  by interface type.
+- **KPI summary** (`/plugins/it-landscape/synthese/`): key counters, attention
+  points (critical apps without server/monitoring…), EAI dependency, most
+  connected applications, top vendors.
+- **Facility comparison** (`/plugins/it-landscape/comparaison/`): similarity
+  matrix (Jaccard), already-mutualized applications, **convergence
+  opportunities** (same process, different applications), facility-specific
+  applications.
+- **Setup wizard** (`/plugins/it-landscape/initialisation/`): ready-to-use
+  modeling bundles — **Hospital IS (SIH)** (admissions, EHR, pharmacy,
+  imaging… with HL7/DICOM flows through an EAI) and **Manufacturing** (ERP,
+  MES, SCADA, WMS… with OPC-UA/EDI flows through an ESB) — domain/process
+  structure + sample applications, VLANs, VMs and flows, in one click.
+- **Multilingual**: English interface with a full French translation
+  (follows the NetBox user language preference).
+- **Full CRUD**: domains, processes, applications, flows (forms, filters,
+  bulk delete, changelog, journal).
+- **REST API**: `/api/plugins/it-landscape/…` (4 endpoints, filters included).
+- **NetBox global search**: applications, flows, domains, processes indexed.
+- **Contextual panels**: applications shown on VM / Device pages, cartography
+  summary on the Site page.
+- **it-landscape data import**: `import_it_landscape` management command.
+
+## Screenshots
+
+### KPI summary
+
+![KPI summary](docs/screenshots/kpi-summary.png)
+
+### Condensed business landscape
+
+![Business landscape](docs/screenshots/business-landscape.png)
+
+### Application view
+
+![Application view](docs/screenshots/application-view.png)
+
+### Flow view
+
+![Flow view](docs/screenshots/flow-view.png)
+
+### Facility comparison
+
+![Facility comparison](docs/screenshots/facility-comparison.png)
+
+## Installation
+
+```bash
+pip install netbox-it-landscape   # or pip install -e /path/to/the/repo
+```
+
+In `configuration.py` (or `/etc/netbox/config/plugins.py` with netbox-docker):
+
+```python
+PLUGINS = ["netbox_it_landscape"]
+```
+
+Then:
+
+```bash
+python manage.py migrate
+```
+
+### Development with the it-landscape Docker stack
+
+The `docker-compose.override.yml` file provided in the it-landscape repository
+mounts this plugin into the NetBox container, installs it in editable mode and
+enables it. From the it-landscape repository:
+
+```bash
+docker compose --profile netbox up -d --force-recreate netbox
+```
+
+## Importing existing data
+
+The it-landscape project JSON files (`<facility>.json`, `<facility>.flux.json`,
+`<facility>.infra.json`, `trigrammes.json`) can be imported in one command:
+
+```bash
+python manage.py import_it_landscape /opt/it-landscape-data --create-sites --with-infra
+```
+
+- **Sites** are resolved by name (`--create-sites` creates missing ones).
+- Applications are **unified by name**: an application present in several
+  facilities becomes a single multi-site record. Trigrams from the JSON files
+  are only used as a resolution key during import.
+- `--with-infra` also creates the test infrastructure: **VMs** (vCPU, RAM,
+  disk, eth0 interface, primary IP, `app:XXX` tag) from `*.infra.json`,
+  **VLANs, prefixes and gateways** from `*.network.json`.
+- **NetBox VMs** are attached to applications via the `*.infra.json` files.
+- Applications referenced only by flows (EAI, monitoring…) are created in an
+  "Out of business referential" domain.
+- The command is **idempotent** (safe to re-run, no duplicates).
+
+## Compatibility
+
+- NetBox ≥ 4.0 (tested on 4.3)
+- Python ≥ 3.10
+
+## License
+
+MIT

netbox_it_landscape-0.2.0/netbox_it_landscape/__init__.py

@@ -0,0 +1,17 @@
+from netbox.plugins import PluginConfig
+
+
+class ITLandscapeConfig(PluginConfig):
+    name = 'netbox_it_landscape'
+    verbose_name = 'IT Landscape'
+    description = (
+        "Cartographie applicative hospitalière intégrée à NetBox : "
+        "vues métier, applicative et flux."
+    )
+    version = '0.2.0'
+    author = 'Laurent Quastana'
+    base_url = 'it-landscape'
+    min_version = '4.0'
+
+
+config = ITLandscapeConfig

netbox_it_landscape-0.2.0/netbox_it_landscape/api/serializers.py

@@ -0,0 +1,78 @@
+from dcim.api.serializers import DeviceSerializer, SiteSerializer
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+from virtualization.api.serializers import VirtualMachineSerializer
+
+from ..models import Application, ApplicationFlow, BusinessDomain, BusinessProcess
+
+
+class BusinessDomainSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_it_landscape-api:businessdomain-detail',
+    )
+    site = SiteSerializer(nested=True)
+
+    class Meta:
+        model = BusinessDomain
+        fields = (
+            'id', 'url', 'display', 'site', 'name', 'description', 'color',
+            'tags', 'custom_fields', 'created', 'last_updated',
+        )
+        brief_fields = ('id', 'url', 'display', 'name')
+
+
+class BusinessProcessSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_it_landscape-api:businessprocess-detail',
+    )
+    domain = BusinessDomainSerializer(nested=True)
+
+    class Meta:
+        model = BusinessProcess
+        fields = (
+            'id', 'url', 'display', 'domain', 'name', 'description',
+            'tags', 'custom_fields', 'created', 'last_updated',
+        )
+        brief_fields = ('id', 'url', 'display', 'name')
+
+
+class ApplicationSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_it_landscape-api:application-detail',
+    )
+    processes = BusinessProcessSerializer(nested=True, many=True, required=False)
+    virtual_machines = VirtualMachineSerializer(nested=True, many=True, required=False)
+    devices = DeviceSerializer(nested=True, many=True, required=False)
+    is_multi_site = serializers.BooleanField(read_only=True)
+
+    class Meta:
+        model = Application
+        fields = (
+            'id', 'url', 'display', 'name', 'processes', 'is_multi_site',
+            'description', 'editor', 'referent', 'hosting', 'criticality',
+            'monitoring_url',
+            'interface_administrative', 'interface_medicale',
+            'interface_facturation', 'interface_planification',
+            'interface_autre',
+            'virtual_machines', 'devices',
+            'tags', 'custom_fields', 'created', 'last_updated',
+        )
+        brief_fields = ('id', 'url', 'display', 'name')
+
+
+class ApplicationFlowSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_it_landscape-api:applicationflow-detail',
+    )
+    site = SiteSerializer(nested=True, required=False, allow_null=True)
+    source = ApplicationSerializer(nested=True)
+    target = ApplicationSerializer(nested=True)
+
+    class Meta:
+        model = ApplicationFlow
+        fields = (
+            'id', 'url', 'display', 'flow_id', 'site', 'source', 'target',
+            'protocol', 'port', 'message_type', 'interface_type', 'eai',
+            'description', 'tags', 'custom_fields', 'created', 'last_updated',
+        )
+        brief_fields = ('id', 'url', 'display', 'flow_id')

netbox_it_landscape-0.2.0/netbox_it_landscape/api/urls.py

@@ -0,0 +1,13 @@
+from netbox.api.routers import NetBoxRouter
+
+from . import views
+
+app_name = 'netbox_it_landscape'
+
+router = NetBoxRouter()
+router.register('business-domains', views.BusinessDomainViewSet)
+router.register('business-processes', views.BusinessProcessViewSet)
+router.register('applications', views.ApplicationViewSet)
+router.register('application-flows', views.ApplicationFlowViewSet)
+
+urlpatterns = router.urls

netbox_it_landscape-0.2.0/netbox_it_landscape/api/views.py

@@ -0,0 +1,33 @@
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from .. import filtersets
+from ..models import Application, ApplicationFlow, BusinessDomain, BusinessProcess
+from . import serializers
+
+
+class BusinessDomainViewSet(NetBoxModelViewSet):
+    queryset = BusinessDomain.objects.select_related('site').prefetch_related('tags')
+    serializer_class = serializers.BusinessDomainSerializer
+    filterset_class = filtersets.BusinessDomainFilterSet
+
+
+class BusinessProcessViewSet(NetBoxModelViewSet):
+    queryset = BusinessProcess.objects.select_related('domain__site').prefetch_related('tags')
+    serializer_class = serializers.BusinessProcessSerializer
+    filterset_class = filtersets.BusinessProcessFilterSet
+
+
+class ApplicationViewSet(NetBoxModelViewSet):
+    queryset = Application.objects.prefetch_related(
+        'processes__domain__site', 'virtual_machines', 'devices', 'tags',
+    )
+    serializer_class = serializers.ApplicationSerializer
+    filterset_class = filtersets.ApplicationFilterSet
+
+
+class ApplicationFlowViewSet(NetBoxModelViewSet):
+    queryset = ApplicationFlow.objects.select_related(
+        'site', 'source', 'target',
+    ).prefetch_related('tags')
+    serializer_class = serializers.ApplicationFlowSerializer
+    filterset_class = filtersets.ApplicationFlowFilterSet