starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-14 06:13:32 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add a Version Requirements Matrix to the NetBox Upgrade Documentation #10809

New Issue
Closed
opened 2025-12-29 21:36:09 +01:00 by adam · 6 comments
adam commented 2025-12-29 21:36:09 +01:00
Owner
Copy Link

Originally created by @pheus on GitHub (Feb 25, 2025).

Originally assigned to: @pheus on GitHub.

Change Type

Addition

Area

Installation/upgrade

Proposed Changes

Hi NetBox team,

I appreciate all the work that goes into maintaining and improving NetBox!

I wanted to propose adding a version requirements matrix to the upgrade documentation. Currently, the upgrade guide focuses on the steps needed to transition between NetBox versions, but it does not explicitly outline the system requirements for each version. Having a clear reference table would make it easier for users to verify compatibility before upgrading, helping to prevent installation issues related to Python, PostgreSQL, or Redis versions.

Here’s an example of how it could be structured:

NetBox Version Python Min Python Max PostgreSQL Min Redis Min Documentation
2.6 3.5 3.7 9.4 - Link
2.7 3.5 3.7 9.4 - Link
2.8 3.6 3.8 9.5 3.4 Link
2.9 3.6 3.8 9.5 4.0 Link
2.10 3.6 3.8 9.6 4.0 Link
2.11 3.6 3.9 9.6 4.0 Link
3.0 3.7 3.9 9.6 4.0 Link
3.1 3.7 3.9 10 4.0 Link
3.2 3.8 3.10 10 4.0 Link
3.3 3.8 3.10 10 4.0 Link
3.4 3.8 3.10 11 4.0 Link
3.5 3.8 3.10 11 4.0 Link
3.6 3.8 3.11 12 4.0 Link
3.7 3.8 3.11 12 4.0 Link
4.0 3.10 3.12 12 4.0 Link
4.1 3.10 3.12 12 4.0 Link
4.2 3.10 3.12 13 4.0 Link

Would love to hear your thoughts on this! I believe it would be a valuable addition to the documentation.

Thanks for your time and consideration! 😊

Originally created by @pheus on GitHub (Feb 25, 2025). Originally assigned to: @pheus on GitHub. ### Change Type Addition ### Area Installation/upgrade ### Proposed Changes Hi NetBox team, I appreciate all the work that goes into maintaining and improving NetBox! I wanted to propose adding a **version requirements matrix** to the upgrade documentation. Currently, the upgrade guide focuses on the steps needed to transition between NetBox versions, but it does not explicitly outline the system requirements for each version. Having a clear reference table would make it easier for users to verify compatibility before upgrading, helping to prevent installation issues related to Python, PostgreSQL, or Redis versions. Here’s an example of how it could be structured: | NetBox Version | Python Min | Python Max | PostgreSQL Min | Redis Min | Documentation | |---------------|------------|------------|----------------|-----------|---------------| | 2.6 | 3.5 | 3.7 | 9.4 | - | [Link](https://github.com/netbox-community/netbox/blob/7fc60cd667d07ed5a43288f3eac5f67c1962d9e8/docs/installation/index.md) | | 2.7 | 3.5 | 3.7 | 9.4 | - | [Link](https://github.com/netbox-community/netbox/blob/ea91e09a1b76c1d389270734141623157827ab5f/docs/installation/index.md) | | 2.8 | **3.6** | **3.8** | **9.5** | **3.4** | [Link](https://github.com/netbox-community/netbox/blob/d79ed76d80835798e47c8eead6fbfc75450b6cef/docs/installation/index.md) | | 2.9 | 3.6 | 3.8 | 9.5 | **4.0** | [Link](https://github.com/netbox-community/netbox/blob/7b05a1817345881239f9a7337b0b8b6ad8cf56a4/docs/installation/index.md) | | 2.10 | 3.6 | 3.8 | **9.6** | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/91ea12344c73797fdd9767fd518b842c3efdb62e/docs/installation/index.md) | | 2.11 | 3.6 | **3.9** | 9.6 | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/f26227ecec9a5a92333f4c9f48bdd4d371b0b2f2/docs/installation/index.md) | | 3.0 | **3.7** | 3.9 | 9.6 | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/fd16c47d2e1d9b3b4a0a9e39de4f3dea759fb250/docs/installation/index.md) | | 3.1 | 3.7 | 3.9 | **10** | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/5a59f2352c39e7040dd4537e5225d609cb14ffc1/docs/installation/index.md) | | 3.2 | **3.8** | **3.10** | 10 | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/d4938b7699115491fdaf3ddf0e830f6120c3ed60/docs/installation/index.md) | | 3.3 | 3.8 | 3.10 | 10 | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/306e98a81ed80ce17b993269fc8d0da9855d8339/docs/installation/index.md) | | 3.4 | 3.8 | 3.10 | **11** | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/def3ccfaee34fb0376efc50f935129c416998d95/docs/installation/index.md) | | 3.5 | 3.8 | 3.10 | 11 | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/eac7d01977d7c23768f651904bbab50d271d10d9/docs/installation/index.md) | | 3.6 | 3.8 | **3.11** | **12** | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/dfcfbe240ddf6f73a61ab857912115afbf78664d/docs/installation/index.md) | | 3.7 | 3.8 | 3.11 | 12 | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/7b90481fc9bc7cf30da5b2027877a2d5cb63a919/docs/installation/index.md) | | 4.0 | **3.10** | **3.12** | 12 | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/91f156de33c557cda3dc3969b5dbb15228a0a776/docs/installation/index.md) | | 4.1 | 3.10 | 3.12 | 12 | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/7bc0d34196323ac992d7ec80b1caa48e6094d88d/docs/installation/index.md) | | 4.2 | 3.10 | 3.12 | **13** | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/9d82a668a4a8a2762d8f1f6a9754234a99888313/docs/installation/index.md) | Would love to hear your thoughts on this! I believe it would be a valuable addition to the documentation. Thanks for your time and consideration! 😊
adam added the status: acceptedtype: documentation labels 2025-12-29 21:36:09 +01:00
adam closed this issue 2025-12-29 21:36:09 +01:00
adam commented 2025-12-29 21:36:10 +01:00
Author
Owner
Copy Link

@GeorgeRyanDev commented on GitHub (Feb 25, 2025):

This is definitely something I would enjoy having from a troubleshooting perspective. Thanks for the suggestion.

@GeorgeRyanDev commented on GitHub (Feb 25, 2025): This is definitely something I would enjoy having from a troubleshooting perspective. Thanks for the suggestion.
adam commented 2025-12-29 21:36:10 +01:00
Author
Owner
Copy Link

@jnovinger commented on GitHub (Mar 27, 2025):

@pheus , is this something you'd like to do, since you've already built out the data?

@jnovinger commented on GitHub (Mar 27, 2025): @pheus , is this something you'd like to do, since you've already built out the data?
adam commented 2025-12-29 21:36:10 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Mar 27, 2025):

@jnovinger Thank you for considering my request!

I'm happy to contribute the matrix to the documentation. Would you prefer it as a new section in the upgrade guide or a separate reference page? I'm happy to put together an initial draft, and we can refine it from there.

@pheus commented on GitHub (Mar 27, 2025): @jnovinger Thank you for considering my request! I'm happy to contribute the matrix to the documentation. Would you prefer it as a new section in the upgrade guide or a separate reference page? I'm happy to put together an initial draft, and we can refine it from there.
adam commented 2025-12-29 21:36:11 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Mar 27, 2025):

I may have found a nice solution!

We could utilize the tab mechanism to toggle between the current and previous versions. This would keep the documentation clean while still making it easy to access historical compatibility information.

I'll add some screenshots to demonstrate how it would look. Let me know what you think!

Screenshot "Current Version":

Image

Screenshot "Previous Versions":

Image

@pheus commented on GitHub (Mar 27, 2025): I may have found a nice solution! We could utilize the tab mechanism to toggle between the current and previous versions. This would keep the documentation clean while still making it easy to access historical compatibility information. I'll add some screenshots to demonstrate how it would look. Let me know what you think! ### Screenshot "Current Version": ![Image](https://github.com/user-attachments/assets/8871d13b-11f1-4895-a307-4af744d1abce) ### Screenshot "Previous Versions": ![Image](https://github.com/user-attachments/assets/8b071c96-2ae3-435e-9548-3a08a2b5b19d)
adam commented 2025-12-29 21:36:11 +01:00
Author
Owner
Copy Link

@jnovinger commented on GitHub (Apr 1, 2025):

@pheus , I like that approach! Let me know when you have something in a PR and I'll shop it around with the rest of team.

Edited to add: I was speaking about the toggleable approach you mentioned in you second comment. I think the Upgrade page is a good place to start with this.

@jnovinger commented on GitHub (Apr 1, 2025): @pheus , I like that approach! Let me know when you have something in a PR and I'll shop it around with the rest of team. Edited to add: I was speaking about the toggleable approach you mentioned in you second comment. I think the Upgrade page is a good place to start with this.
adam commented 2025-12-29 21:36:11 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Apr 1, 2025):

Sounds great! I'll put together a PR with the toggleable approach and add it to the Upgrade page. Thanks for the guidance! 🚀

@pheus commented on GitHub (Apr 1, 2025): Sounds great! I'll put together a PR with the toggleable approach and add it to the Upgrade page. Thanks for the guidance! 🚀
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#10809
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?