Netbox-docker Versioning

[gaigelama]

Desired Behavior

N/A - for the moment

Contrast to Current Behavior

N/A - for the moment

Required Changes

N/A - for the moment

Discussion: Benefits and Drawbacks

Greetings,

I'd like to discuss the versioning of the tags/releases and docker tags for this repo. The uv package manager was recently introduced in 3.2.0 and it's pretty cool and appreciated. However, this did introduce a breaking change for people adding Netbox plugins.

I wasn't able to find how versioning is defined for this repo so I can only assume it's using semver like Netbox.

If this repo does follow semver, then afaik the 3.2.0 should have been a 4.0.0 release.

However, I have been using the Netbox version for the docker tags such as v4.2.7 which is completely different than the release versioning of this repo.

This introduces some misguided expectations (imo) though I think that's on me for not reading the README first since I just grabbed whatever the helm chart was using.

I was under the impression I could switch from netbox image v4.2.2 to v4.2.7 and have no breaking changes but I needed to figure out why pip wasn't found and once I fixed that I'm now getting the error in my netbox container:

packaging.version.InvalidVersion: Invalid version: '4.2.7-Docker-3.2.0'
[ Use DB_WAIT_DEBUG=1 in netbox.env to print full traceback for errors here ]

I don't mind spending the time fixing this on my side but I could see a scenario where a 0day is fixed in v4.2.8 and an organization tries to upgrade from v4.2.2 but is left vulnerable because that have to go deal with breaking changes in this repo first.

If my assumptions are correct, I would suggest we better follow semver and additionally match major versions between this repo and netbox. So if this repo has v3 and netbox is v4, this repo would continue to support v3 as long as Netbox v4 is supported. When Netbox v5 comes out, this repo would put their planned breaking changes into v4. You could also have netbox-docker v4 with Netbox v4, but the docker tag for Netbox v4 would only have netbox-docker v3 changes.

If this turns into a larger discussion I can populate the required fields above.

I appreciate all of your contributions to this repo as well, it's made deploying Netbox a breeze.

[crlsgms]

Noticed the same issue here, while updating to the latest 4.2.6, the tag from the current v4.2-3.2.0 was overwritten with the same as v4.2.7-3.2.0, and while building the plugin image I have the same error of version mismatch.

I have the old image cached in my local registry, but for sure anyone who follows up the docs to update and add plugins to this new image version will have a broken setup.

[crlsgms]

As I had this old image here on my registry was possible to rollback and create the new plugin image.

Also I have to adapt the Dockerfile-Plugin with the newer configs for uv, but the diode plugin is using this new configs that was already fixed on topology_views package

Dockerfile_plugins:

## FROM netboxcommunity/netbox:v4.2-3.2.0
# FROM registry.test.zone/dockerhub/netboxcommunity/netbox:v4.2.7-3.2.0
# FROM registry.test.zone/sysops/netbox-zeal:v4.2.6-3.2.0
FROM registry.test.h.zone/netboxcommunity/netbox:v4.2.6-3.2.0

COPY ./plugin_requirements.txt /opt/netbox/
RUN /usr/local/bin/uv pip install --no-cache-dir -r /opt/netbox/plugin_requirements.txt

# Prepare static image directory for Topology Views plugin
RUN mkdir -p /opt/netbox/netbox/static/netbox_topology_views/img

COPY configuration/configuration.py /etc/netbox/config/configuration.py
COPY configuration/plugins.py /etc/netbox/config/plugins.py
COPY local_settings.py /opt/netbox/netbox/netbox/local_settings.py

# Gix for docker version on topology views, need to set to diode plugin now
## RUN sed -i 's/NETBOX_CURRENT_VERSION = version.parse(settings.VERSION)/NETBOX_CURRENT_VERSION = version.parse(settings.RELEASE.version)/' \
##     /opt/netbox/venv/lib/python3.12/site-packages/netbox_topology_views/template_content.py

# Save installed plugins to file (visible in container or via image inspection)
RUN /usr/local/bin/uv pip freeze | grep -Ei 'netbox|pycryptodome' | paste -sd "," - > /opt/netbox/PLUGINS_INSTALLED.txt

RUN DEBUG="true" SECRET_KEY="dummydummydummydummydummydummydummydummydummydummy" \
    /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input

My plugin list

netbox-secrets
netbox-topology-views
netbox-floorplan-plugin
netbox-bgp
netbox-acls
netbox-inventory
netbox-plugin-dns
netbox-lifecycle
netbox-reorder-rack
slurpit-netbox
netbox-qrcode
# netboxlabs-diode-netbox-plugin
netboxlabs-netbox-branching

[gaigelama]

I was going to use v4.2.7-3.1.1 but it apparently doesn't exist.

It looks like our options are:
Build from a modified netbox-docker or new Dockerfile
Stay on the latest Netbox version supported by 3.1.1
Fix the broken changes in the Dockerfile and possibly Netbox with the new version display.

I don't think these are great option though. I'd be more than glad to contribute some additional images for v4.2.x-3.1.1 but I'd need to look into how it's done.

I might be missing some information though, so I apologize if what I said is incorrect. I don't want to have any unreasonable expectations given this an open source project.

[sistemmsn]

I have the same problem, what version should I use to be able to raise it?

packaging.version.InvalidVersion: Invalid version: '4.2.7-Docker-3.2.0'

[sistemmsn]

That version doesn't work for me either, I'm trying to install the plugins, the image is created correctly but when I open the compose it gives that e
FROM netboxcommunity/netbox:v4.2.6-3.2.0