From 175a01b257205f943dbed0fdae21c1dbbe4ead72 Mon Sep 17 00:00:00 2001 From: wkoot <3715211+wkoot@users.noreply.github.com> Date: Tue, 25 Feb 2025 20:13:25 +0100 Subject: [PATCH] Release plugin version 1.8.0 (#64) Closes #63 Signed-off-by: wkoot <3715211+wkoot@users.noreply.github.com> --- CHANGELOG.md | 2 + LICENSE | 208 ++++++++++++++++++++++++++++++++++++-- MAINTENANCE.md | 151 ++++++++++++++++++++++++++++ README.md | 209 +++++---------------------------------- netbox_slm/__init__.py | 18 +++- pyproject.toml | 11 ++- sonar-project.properties | 2 +- 7 files changed, 402 insertions(+), 199 deletions(-) create mode 100644 MAINTENANCE.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b32de7..ecb484b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## [Unreleased] +## [1.8.0](https://github.com/ICTU/netbox_slm/releases/tag/1.8.0) - 2025-02-25 + ### Added * Toggle to show plugin as top level menu item (#42) diff --git a/LICENSE b/LICENSE index 7a3c89b..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,201 @@ -Copyright 2022 ICTU + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -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 + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - http://www.apache.org/licenses/LICENSE-2.0 + 1. Definitions. -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. + "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 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 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 those 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. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 0000000..5aee724 --- /dev/null +++ b/MAINTENANCE.md @@ -0,0 +1,151 @@ +# Maintenance related tasks + + +## Version upgrade workflow + +1. Update version spec in `netbox_slm/__init__.py` and `sonar-project.properties` +1. Check for any runtime errors and warnings in the `netbox-*` container logs +1. Create new version tag on GitHub, following semantic versioning as: `MAJOR.MINOR.PATCH` +1. Update the `CHANGELOG.md` with new version information and move `[Unreleased]` items to new version section +1. Build the package: `python -m build` +1. Upload the distributions to PyPI: `twine upload --skip-existing dist/*` + + +## Developer Guide (local installation) + +*Follow the steps below on your local system to run NetBox and the +`netbox_slm` plugin in developer mode* + +### Setup + +The goal below is to run all NetBox components in Docker and run a local +NetBox Django copy with auto-reload to develop the plugin pointing to +the PostgreSQL and Redis container instances, basically ignoring the +NetBox docker runtime server. + +### Steps + +from your projects directory clone the NetBox repository + +```shell +$ git clone https://github.com/netbox-community/netbox +$ cd netbox +``` + +install the virtual environment + +```shell +$ pipenv shell +$ pipenv install +``` + +create and edit `netbox/configuration.py` (based on the template file) add these lines at the end of the file; + +```python +DEBUG = True +SECRET_KEY = 'dummy' +PLUGINS = [ +'netbox_slm', +] +``` + +The NetBox installation above will be used to run Django management +commands like `runserver`, `makemigrations` and `migrate`, which will be +explained in the next steps below; + +from your projects directory clone the `netbox_slm` repository + +```shell +$ git clone https://github.com/ICTU/netbox_slm +$ cd netbox_slm +$ ./start-netbox.sh +``` + +This will start NetBox locally (requires Docker) and forward the Redis +and PostgreSQL ports to the localhost (make sure there’s no processes +using these ports or change the Dockerfile(s) accordingly) + +Note, you can also start and stop NetBox by hand: + +```shell +$ cd netbox-docker +$ docker compose up -d +``` + +or stop the stack with + +```shell +$ docker compose down +``` + +#### to start fresh: + +```shell +$ docker compose down +$ docker volume rm netbox-docker_netbox-postgres-data # et cetera +$ docker compose up -d --force-recreate +``` + +this will require you to re-run the migrate commando's for `netbox_slm`, see further down below + +Go back to the NetBox `configuration.py` file and update the PostgreSQL and +Redis connection strings (username, password) to the ones the NetBox +Docker backend is using, for example (using default user and passwords +from the NetBox Docker example): + +```python +# PostgreSQL database configuration. See the Django documentation for a complete list of available parameters: +# https://docs.djangoproject.com/en/stable/ref/settings/#databases +DATABASE = { + 'NAME': 'netbox', # Database name + 'USER': 'netbox', # PostgreSQL username + 'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password + 'HOST': 'localhost', # Database server + 'PORT': '', # Database port (leave blank for default) + 'CONN_MAX_AGE': 300, # Max database connection age +} + +# Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate +# configuration exists for each. Full connection details are required in both sections, and it is strongly recommended +# to use two separate database IDs. +REDIS = { + 'tasks': { + 'HOST': 'localhost', + 'PORT': 6379, + # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel + # 'SENTINELS': [('mysentinel.redis.example.com', 6379)], + # 'SENTINEL_SERVICE': 'netbox', + 'PASSWORD': 'H733Kdjndks81', + 'DATABASE': 0, + 'SSL': False, + # Set this to True to skip TLS certificate verification + # This can expose the connection to attacks, be careful + # 'INSECURE_SKIP_TLS_VERIFY': False, + }, + 'caching': { + 'HOST': 'localhost', + 'PORT': 6379, + # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel + # 'SENTINELS': [('mysentinel.redis.example.com', 6379)], + # 'SENTINEL_SERVICE': 'netbox', + 'PASSWORD': 'H733Kdjndks81', + 'DATABASE': 1, + 'SSL': False, + # Set this to True to skip TLS certificate verification + # This can expose the connection to attacks, be careful + # 'INSECURE_SKIP_TLS_VERIFY': False, + } +} +``` + +Now you can run commands from the NetBox repository like this; + +```shell +$ cd netbox/netbox +$ export PYTHONPATH=../../netbox_slm/netbox_slm/ # or with the pipenv activated run `python3 setup.py develop` from the netbox_slm directory +$ python3 manage.py migrate netbox_slm +$ python3 manage.py runserver 8001 +``` + +Visit http://127.0.0.1:8001 in the browser to see the auto reloading version of the NetBox UI. +Port 8000 is taken by the Docker ran variant. diff --git a/README.md b/README.md index fd4e57a..7734c1b 100644 --- a/README.md +++ b/README.md @@ -13,18 +13,13 @@ -## 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 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` repository 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 SLM plugin: +Note that this plugin is only tested against a single NetBox version at this time, see [Dockerfile-CI](https://github.com/ICTU/netbox_slm/blob/master/ci/Dockerfile-CI). + +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 SLM plugin: 1. Add ``netbox_slm`` to the ``PLUGINS`` list in ``configuration/plugins.py``. @@ -32,193 +27,35 @@ to install the NetBox SLM plugin: contents. 3. Create a ``Dockerfile-SLM`` with contents: - ``` - FROM netboxcommunity/netbox:vX.Y.Z +```dockerfile +FROM netboxcommunity/netbox:vX.Y.Z - COPY ./plugin_requirements.txt / - RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt - ``` +COPY ../pyproject.toml /tmp/ +RUN uv pip install -r /tmp/pyproject.toml +``` 4. Create a ``docker-compose.override.yml`` with contents: - ``` - version: '3.7' - services: - netbox: - ports: - - 8000:8080 - build: - context: . - dockerfile: Dockerfile-SLM - image: netbox:slm - netbox-worker: - image: netbox:slm - netbox-housekeeping: - image: netbox:slm - ``` +```yaml +version: "3.7" +services: + netbox: + ports: + - "8000:8080" + build: + context: . + dockerfile: Dockerfile-SLM + image: netbox:slm + netbox-worker: + image: netbox:slm + netbox-housekeeping: + image: netbox:slm +``` Now, build the image: ``docker compose build --no-cache`` And finally, run NetBox with the SLM plugin: ``docker compose up`` -## Releasing Guide - -To draft a release; - -update the `netbox_slm/__init__.py` file to reflect the new version, then from the *src* -directory run - - ``` - $ python -m build - $ twine upload dist/* - ``` - -On GitHub create a similar tag and version. - - -## Developer Guide (local installation) - -*Follow the steps below on your local system to run NetBox and the -`netbox_slm` plugin in developer mode* - -### Setup - -The goal below is to run all NetBox components in Docker and run a local -NetBox Django copy with auto-reload to develop the plugin pointing to -the PostgreSQL and Redis container instances, basically ignoring the -NetBox docker runtime server. - -### Steps - -from your projects directory clone the NetBox repository - - ``` - $ git clone https://github.com/netbox-community/netbox - $ cd netbox - ``` - -install the virtual environment - - ``` - $ pipenv shell - $ pipenv install - ``` - -create and edit `netbox/configuration.py` (based on the template file) add these lines at the end of the file; - - ``` - DEBUG = True - SECRET_KEY = 'dummy' - PLUGINS = [ - 'netbox_slm', - ] - ``` - -The NetBox installation above will be used to run Django management -commands like `runserver`, `makemigrations` and `migrate`, which will be -explained in the next steps below; - -from your projects directory clone the `netbox_slm` repository - - ``` - $ git clone https://github.com/ICTU/netbox_slm - $ cd netbox_slm - $ ./start-netbox.sh - ``` - -This will start NetBox locally (requires Docker) and forward the Redis -and PostgreSQL ports to the localhost (make sure there’s no processes -using these ports or change the Dockerfile(s) accordingly) - -Note, you can also start and stop NetBox by hand: - - ``` - $ cd netbox-docker - $ docker compose up -d - ``` - -or stop the stack with - - ``` - $ docker compose down - ``` - -# to start fresh: - - ``` - $ docker compose down - $ docker volume rm netbox-docker_netbox-postgres-data # et cetera - $ docker compose up -d --force-recreate - ``` - -this will require you to re-run the migrate commando's for `netbox_slm`, see further down below - -Go back to the NetBox `configuration.py` file and update the PostgreSQL and -Redis connection strings (username, password) to the ones the NetBox -Docker backend is using, for example (using default user and passwords -from the NetBox Docker example): - - ``` - <> - - # PostgreSQL database configuration. See the Django documentation for a complete list of available parameters: - # https://docs.djangoproject.com/en/stable/ref/settings/#databases - DATABASE = { - 'NAME': 'netbox', # Database name - 'USER': 'netbox', # PostgreSQL username - 'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password - 'HOST': 'localhost', # Database server - 'PORT': '', # Database port (leave blank for default) - 'CONN_MAX_AGE': 300, # Max database connection age - } - - # Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate - # configuration exists for each. Full connection details are required in both sections, and it is strongly recommended - # to use two separate database IDs. - REDIS = { - 'tasks': { - 'HOST': 'localhost', - 'PORT': 6379, - # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel - # 'SENTINELS': [('mysentinel.redis.example.com', 6379)], - # 'SENTINEL_SERVICE': 'netbox', - 'PASSWORD': 'H733Kdjndks81', - 'DATABASE': 0, - 'SSL': False, - # Set this to True to skip TLS certificate verification - # This can expose the connection to attacks, be careful - # 'INSECURE_SKIP_TLS_VERIFY': False, - }, - 'caching': { - 'HOST': 'localhost', - 'PORT': 6379, - # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel - # 'SENTINELS': [('mysentinel.redis.example.com', 6379)], - # 'SENTINEL_SERVICE': 'netbox', - 'PASSWORD': 'H733Kdjndks81', - 'DATABASE': 1, - 'SSL': False, - # Set this to True to skip TLS certificate verification - # This can expose the connection to attacks, be careful - # 'INSECURE_SKIP_TLS_VERIFY': False, - } - } - - <> - ``` - -Now you can run commands from the NetBox repository like this; - - ``` - $ cd netbox/netbox - $ export PYTHONPATH=../../netbox_slm/netbox_slm/ # or with the pipenv activated run `python3 setup.py develop` from the netbox_slm directory - $ python3 manage.py migrate netbox_slm - $ python3 manage.py runserver 8001 - ``` - -Visit http://127.0.0.1:8001 in the browser to see the auto reloading version of the NetBox UI. -Port 8000 is taken by the Docker ran variant. - ## Get in touch diff --git a/netbox_slm/__init__.py b/netbox_slm/__init__.py index 9066b0e..5219a2b 100644 --- a/netbox_slm/__init__.py +++ b/netbox_slm/__init__.py @@ -1,6 +1,22 @@ +""" +Copyright 2022-2025 ICTU + +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. +""" + from netbox.plugins import PluginConfig -__version__ = "1.7.0" +__version__ = "1.8.0" class SLMConfig(PluginConfig): diff --git a/pyproject.toml b/pyproject.toml index f02dd9a..24e07d6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,16 +13,20 @@ authors = [ {name = "ICTU", email = "open-source-projects@ictu.nl"}, ] classifiers = [ + "Development Status :: 5 - Production/Stable", + "Environment :: Plugins", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", + "Intended Audience :: System Administrators", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", - "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", ] @@ -41,6 +45,11 @@ ci = [ "ruff == 0.9.6", ] +[project.urls] +Homepage = "https://github.com/ICTU/netbox_slm/" +Changelog = "https://github.com/ICTU/netbox_slm/blob/master/CHANGELOG.md" +Issues = "https://github.com/ICTU/netbox_slm/issues/" + [tool.setuptools.dynamic] version = {attr = "netbox_slm.__version__"} diff --git a/sonar-project.properties b/sonar-project.properties index f7742b4..df3ac8b 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -2,7 +2,7 @@ sonar.organization=ictu sonar.projectKey=ICTU_netbox_slm sonar.projectName=netbox-slm -sonar.projectVersion=1.7.0 +sonar.projectVersion=1.8.0 # Path is relative to the sonar-project.properties file sonar.sources=netbox_slm