MrBlake/NetBox-SLM
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README.rst

Browse Source
This commit is contained in:
Hedde van der Heide
2022-04-10 11:22:33 +02:00
parent 15b61fd7f9
commit e9422d70e3
2 changed files with 7 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rst
+1 -2
View File
@@ -20,7 +20,7 @@ to install the Netbox SLM plugin:
1. Add ``netbox_slm`` to the ``PLUGINS`` list in 1. Add ``netbox_slm`` to the ``PLUGINS`` list in
``configuration/extra.py``. ``configuration/extra.py``.
2. Create a ``plugin_requirements.txt`` with ``netbox-slm==0.94`` as 2. Create a ``plugin_requirements.txt`` with ``netbox-slm==0.95`` as
contents. contents.
3. Create a ``Dockerfile-SLM`` with contents: 3. Create a ``Dockerfile-SLM`` with contents:
@@ -96,7 +96,6 @@ Steps
$ git clone https://github.com/netbox-community/netbox $ git clone https://github.com/netbox-community/netbox
$ cd netbox $ cd netbox
$ git checkout f5356b8 (to pin 3.0.9)
install the virtual environment install the virtual environment
src/README.rst
+6 -15
View File
@@ -14,19 +14,19 @@ quickstart <https://github.com/netbox-community/netbox-docker#quickstart>`__
instructions to clone the netbox-docker repo and set up the instructions to clone the netbox-docker repo and set up the
``docker-compose.override.yml``. ``docker-compose.override.yml``.
Next, follow these instructions (based on the generic `Netbox plugin Next, follow these instructions (based on the `Netbox docker variant
instructions <https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins>`__) instructions <https://github.com/netbox-community/netbox-docker/wiki/Configuration#custom-configuration-files>`__)
to install the Netbox SLM plugin: to install the Netbox SLM plugin:
1. Add ``netbox_slm`` to the ``PLUGINS`` list in 1. Add ``netbox_slm`` to the ``PLUGINS`` list in
``configuration/configuration.py``. ``configuration/extra.py``.
2. Create a ``plugin_requirements.txt`` with ``netbox-slm==0.93`` as 2. Create a ``plugin_requirements.txt`` with ``netbox-slm==0.94`` as
contents. contents.
3. Create a ``Dockerfile-SLM`` with contents: 3. Create a ``Dockerfile-SLM`` with contents:
.. code:: dockerfile .. code:: dockerfile
FROM netboxcommunity/netbox:v3.0.9 # The Netbox SLM plugin currently only works with v3.0.9 of Netbox due to backwards incompatible changes in newer version of Netbox FROM netboxcommunity/netbox:v3.X.X
COPY ./plugin_requirements.txt / COPY ./plugin_requirements.txt /
RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt
@@ -63,7 +63,7 @@ directory run
:: ::
# make sure to update the version in netbox_slm/__init__.py and setup.cfg # make sure to update the version in netbox_slm/__init__.py
$ python setup.py sdist $ python setup.py sdist
$ twine upload dist/* $ twine upload dist/*
@@ -87,15 +87,6 @@ Netbox Django copy with auto-reload to develop the plugin pointing to
the Dockerized postgres and redis instances, basically ignoring the the Dockerized postgres and redis instances, basically ignoring the
netbox docker runtime server. netbox docker runtime server.
Gotcha’s
~~~~~~~~
*Netbox’s exception handler seems to supress initial Exceptions,
obfuscating missing imports or other Django related issues by re-raising
an opague error, e.g. netbox_slm plugin namespace doesnotexist. It’s
recommended to often check the runtime server or patch Netbox’s global
exception handler.*
Steps Steps
~~~~~ ~~~~~