Skip to content

Netbox-docker Versioning #1440

@gaigelama

Description

@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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions