-
Notifications
You must be signed in to change notification settings - Fork 2
/
PKG-INFO
136 lines (106 loc) · 5.23 KB
/
PKG-INFO
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
Metadata-Version: 2.1
Name: netbox-svm
Version: 1.1.6
Summary: Software Version Management Netbox Plugin fork from netbox-slm 1.7.0
Home-page: https://github.com/hocchudong/netbox-software-version-manager
Author-email: hungnv <[email protected]>
License: Apache-2.0
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.10.12
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: build
Requires-Dist: build==1.2.1; extra == "build"
Requires-Dist: setuptools==70.3.0; extra == "build"
Requires-Dist: twine==5.1.1; extra == "build"
Provides-Extra: tools
Requires-Dist: ruff==0.5.1; extra == "tools"
# NetBox SVM
<p align="center"><i>Netbox Plugin software version manager of software components, including versions and installations.</i></p>
<div align="center">
<a href="https://pypi.org/project/netbox-svm/"><img src="https://img.shields.io/pypi/v/netbox-svm" alt="PyPi"/></a>
<a href="https://github.com/hocchudong/netbox-software-version-manager/stargazers"><img src="https://img.shields.io/github/stars/hocchudong/netbox-software-version-manager" alt="Stars Badge"/></a>
<a href="https://github.com/hocchudong/netbox-software-version-manager/network/members"><img src="https://img.shields.io/github/forks/hocchudong/netbox-software-version-manager" alt="Forks Badge"/></a>
<a href="https://github.com/hocchudong/netbox-software-version-manager/pulls"><img src="https://img.shields.io/github/issues-pr/hocchudong/netbox-software-version-manager" alt="Pull Requests Badge"/></a>
<a href="https://github.com/hocchudong/netbox-software-version-manager/issues"><img src="https://img.shields.io/github/issues/hocchudong/netbox-software-version-manager" alt="Issues Badge"/></a>
<a href="https://github.com/hocchudong/netbox-software-version-manager/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/hocchudong/netbox-software-version-manager?color=2b9348"></a>
<a href="https://github.com/hocchudong/netbox-software-version-manager/blob/master/LICENSE"><img src="https://img.shields.io/github/license/hocchudong/netbox-software-version-manager?color=2b9348" alt="License Badge"/></a>
</div>
## Install Require
netbox version >= 4.0
## Known Issues
- WARNING: This plugin is only tested with a single NetBox version at this time.
- CSV/Bulk imports for SoftwareProduct, Version and Installation are currently broken (WIP)
## Installation Guide
### In mono service:
To install the plugin, first using pip and install netbox-svm:
```
cd /opt/netbox
source venv/bin/activate
pip install netbox-svm
```
Next, enable the plugin in /opt/netbox/netbox/netbox/configuration.py, or if you have a /configuration/plugins.py file, the plugins.py file will take precedence.
```
PLUGINS = [
'netbox_svm'
]
```
Then you may need to perform the final step of restarting the service to ensure that the changes take effect correctly:
```
python netbox/manage.py migrate netbox_svm
sudo systemctl restart netbox
```
### In docker env
When using the Docker version of NetBox, first follow the netbox-docker [quickstart](https://github.com/netbox-community/netbox-docker#quickstart) instructions to clone the netbox-docker repo and set up the ``docker-compose.override.yml``.
Next, follow these instructions (based on the NetBox docker variant
[instructions](https://github.com/netbox-community/netbox-docker/wiki/Configuration#custom-configuration-files))
to install the NetBox SVM plugin:
1. Add ``netbox_svm`` to the ``PLUGINS`` list in
``configuration/plugins.py``.
2. Create a ``plugin_requirements.txt`` with ``netbox-svm`` as
contents.
3. Create a ``Dockerfile-SVM`` with contents:
```
FROM netboxcommunity/netbox:v4.0
COPY ./plugin_requirements.txt /
RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt
```
4. Create a ``docker-compose.override.yml`` with contents:
```
version: '3.7'
services:
netbox:
ports:
- 8000:8080
build:
context: .
dockerfile: Dockerfile-SVM
image: netbox:svm
netbox-worker:
image: netbox:svm
netbox-housekeeping:
image: netbox:svm
```
Now, build the image: ``docker compose build --no-cache``
And finally, run NetBox with the SVM plugin: ``docker compose up -d``
## Releasing Guide
To draft a release;
update the `netbox_svm/__init__.py` file to reflect the new version, then from the *src*
directory run
```
$ python -m build
$ twine upload dist/*
```
On Github.com create a similar tag and version. These steps could be
automated with a github workflow.