# NetBox Data Flows Plugin
NetBox plugin to document Data Flows between devices and applications.
## Features
* Document data flows between IP addresses, IP ranges and Prefixes documented in NetBox.
* Regroup the data flows into applications and hierarchical groups.
Documenting your data flows can help you design the network architecture, automate your firewall rule definition or reviews, implement security contracts in a software-defined network, or respond to compliance requirements.
## Screenshots
### Data Flow
A data flow for an application, here representing the user access to frontend servers and backend servers over TCP/443.
Details of the data flow specifications, displaying all the IP addresses, IP ranges and Prefixes that are involved in that data flow.
### Application
The application allows you to group all the related data flows.
### Device tab views
The plugin adds Tab views to Devices, Virtual Machines, IP addresses, IP ranges and Prefixes to list all the data flows that involve them as a source or destination.
## Getting started
Read the [Quick Start tutorial](docs/quick-start.md) to discover how to use the plugin.
## Data model
The data model and design's decisions can be found in the [documentation](docs/data-model.md).
## Installation and configuration
Instructions to install, configure, update or uninstall the plugin can be found in the [plugin's documentation](docs/installation-configuration.md).
### Supported Versions
| netbox version | netbox-data-flows version |
| -------------- | ----------------------------- |
| >= 4.1.0 | >= v1.0.4 |
| >= 4.0.0 | >= v0.9.0 |
| >= 3.7.0 | >= v0.8.0, < v0.9.0 |
| >= 3.6.0 | >= v0.7.3, < v0.8.0 |
| < 3.6.0 | Not supported |
### Dependencies
* NetBox (>=4.0.0)
* Python 3.10 or higher
## Contributions
Contributions are welcomed. This plugin is developped on the free time of its author, so do not expect regular releases.
Please report security vulnerabilities via [GitHub security advisory](https://github.com/Alef-Burzmali/netbox-data-flows/security). Do not create a public issue. See also the [Security Policy](https://github.com/Alef-Burzmali/blob/main/SECURITY.md).
Please report bugs and feature requests in GitHub.
[GitHub Discussions](https://github.com/Alef-Burzmali/netbox-data-flows/discussions) are opened for general help requests and any other topics you may want to discuss.
### Known bugs and limitations
* GraphQL API is not implemented
See also the [list of issues](https://github.com/Alef-Burzmali/netbox-data-flows/issues).
Raw data
{
"_id": null,
"home_page": null,
"name": "netbox-data-flows",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "netbox, netbox-plugins",
"author": "Thomas Fargeix",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c1/f8/2b68955448981434913d2185d8495a5efae3bf72f54f2421a3b74bcc1ea0/netbox_data_flows-1.0.6.tar.gz",
"platform": null,
"description": "# NetBox Data Flows Plugin\n\nNetBox plugin to document Data Flows between devices and applications.\n\n## Features\n\n* Document data flows between IP addresses, IP ranges and Prefixes documented in NetBox.\n* Regroup the data flows into applications and hierarchical groups.\n\nDocumenting your data flows can help you design the network architecture, automate your firewall rule definition or reviews, implement security contracts in a software-defined network, or respond to compliance requirements.\n\n## Screenshots\n\n### Data Flow\n\n\nA data flow for an application, here representing the user access to frontend servers and backend servers over TCP/443.\n\n\nDetails of the data flow specifications, displaying all the IP addresses, IP ranges and Prefixes that are involved in that data flow.\n\n### Application\n\n\nThe application allows you to group all the related data flows.\n\n### Device tab views\n\n\nThe plugin adds Tab views to Devices, Virtual Machines, IP addresses, IP ranges and Prefixes to list all the data flows that involve them as a source or destination.\n\n## Getting started\n\nRead the [Quick Start tutorial](docs/quick-start.md) to discover how to use the plugin.\n\n## Data model\n\nThe data model and design's decisions can be found in the [documentation](docs/data-model.md).\n\n## Installation and configuration\n\nInstructions to install, configure, update or uninstall the plugin can be found in the [plugin's documentation](docs/installation-configuration.md).\n\n### Supported Versions\n\n| netbox version | netbox-data-flows version |\n| -------------- | ----------------------------- |\n| >= 4.1.0 | >= v1.0.4 |\n| >= 4.0.0 | >= v0.9.0 |\n| >= 3.7.0 | >= v0.8.0, < v0.9.0 |\n| >= 3.6.0 | >= v0.7.3, < v0.8.0 |\n| < 3.6.0 | Not supported |\n\n### Dependencies\n\n* NetBox (>=4.0.0)\n* Python 3.10 or higher\n\n\n## Contributions\n\nContributions are welcomed. This plugin is developped on the free time of its author, so do not expect regular releases.\n\nPlease report security vulnerabilities via [GitHub security advisory](https://github.com/Alef-Burzmali/netbox-data-flows/security). Do not create a public issue. See also the [Security Policy](https://github.com/Alef-Burzmali/blob/main/SECURITY.md).\n\nPlease report bugs and feature requests in GitHub.\n\n[GitHub Discussions](https://github.com/Alef-Burzmali/netbox-data-flows/discussions) are opened for general help requests and any other topics you may want to discuss.\n\n### Known bugs and limitations\n\n* GraphQL API is not implemented\n\nSee also the [list of issues](https://github.com/Alef-Burzmali/netbox-data-flows/issues).\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "NetBox plugin to document data flows between systems and applications.",
"version": "1.0.6",
"project_urls": {
"Bug Tracker": "https://github.com/Alef-Burzmali/netbox-data-flows/issues",
"Documentation": "https://Alef-Burzmali.github.io/netbox-data-flows",
"Homepage": "https://github.com/Alef-Burzmali/netbox-data-flows"
},
"split_keywords": [
"netbox",
" netbox-plugins"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02402edd84f3987244136e41ac7180e6d947190f2cd3cb44376491ee993f0657",
"md5": "b8f1e0634368303f8a2e6f8db9c45c7b",
"sha256": "98295d520a842d644723082d0701416c3d07ff5181b704256eb3580ebd956fdb"
},
"downloads": -1,
"filename": "netbox_data_flows-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8f1e0634368303f8a2e6f8db9c45c7b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 73663,
"upload_time": "2024-10-27T16:55:00",
"upload_time_iso_8601": "2024-10-27T16:55:00.696479Z",
"url": "https://files.pythonhosted.org/packages/02/40/2edd84f3987244136e41ac7180e6d947190f2cd3cb44376491ee993f0657/netbox_data_flows-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c1f82b68955448981434913d2185d8495a5efae3bf72f54f2421a3b74bcc1ea0",
"md5": "a218be9a676837d9d745288ce881299a",
"sha256": "c9a204f1a680e733085bcd3daa1ef7a15f13617170f08d2b34f1d3035a9c66ba"
},
"downloads": -1,
"filename": "netbox_data_flows-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "a218be9a676837d9d745288ce881299a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 2333067,
"upload_time": "2024-10-27T16:55:02",
"upload_time_iso_8601": "2024-10-27T16:55:02.150507Z",
"url": "https://files.pythonhosted.org/packages/c1/f8/2b68955448981434913d2185d8495a5efae3bf72f54f2421a3b74bcc1ea0/netbox_data_flows-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 16:55:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Alef-Burzmali",
"github_project": "netbox-data-flows",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netbox-data-flows"
}
JSON
