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

Move most of NetBox's configuration parameters into the database #4600

New Issue
Closed
opened 2025-12-29 18:38:08 +01:00 by adam · 6 comments
adam commented 2025-12-29 18:38:08 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Feb 26, 2021).

Originally assigned to: @jeremystretch on GitHub.

Environment

  • Python version: 3.7.9
  • NetBox version: 2.10.5

Proposed Functionality

Currently, NetBox stores its configuration in (wait for it) configuration.py, as a set of Python variables that get loaded at start time. This FR proposes moving most of this configuration into the database, perhaps as a monolithic JSON object. Critical configuration parameters, such as database and Redis details, would stay in configuration.py.

Use Case

There are a few benefits to this approach. First, it would allow us to provide a convenient UI and API for managing configuration settings. (Arguably that could also be done with a flat file, but using the database simplifies things quite a bit.)

It would also make highly available deployments a bit easier, as the configuration would be synchronized among nodes automatically, without having to set up a separate process to replication the configuration file.

Finally, it could also afford us the ability to store configuration revisions (if we store every configuration as a snapshot). Users could easily make a change, and then revert to a previous configuration if it goes wrong.

Database Changes

We'd probably create a ConfigurationRevision class or something to that effect. It would be a standard model, but might include a bit of additional logic for managing.

External Dependencies

The django-constance library is worth checking out, though it might be overkill.

Originally created by @jeremystretch on GitHub (Feb 26, 2021). Originally assigned to: @jeremystretch on GitHub. ### Environment * Python version: 3.7.9 * NetBox version: 2.10.5 ### Proposed Functionality Currently, NetBox stores its configuration in (wait for it) `configuration.py`, as a set of [Python variables](https://netbox.readthedocs.io/en/stable/configuration/) that get loaded at start time. This FR proposes moving most of this configuration into the database, perhaps as a monolithic JSON object. Critical configuration parameters, such as database and Redis details, would stay in `configuration.py`. ### Use Case There are a few benefits to this approach. First, it would allow us to provide a convenient UI and API for managing configuration settings. (Arguably that could also be done with a flat file, but using the database simplifies things quite a bit.) It would also make highly available deployments a bit easier, as the configuration would be synchronized among nodes automatically, without having to set up a separate process to replication the configuration file. Finally, it could also afford us the ability to store configuration revisions (if we store every configuration as a snapshot). Users could easily make a change, and then revert to a previous configuration if it goes wrong. ### Database Changes We'd probably create a `ConfigurationRevision` class or something to that effect. It would be a standard model, but might include a bit of additional logic for managing. ### External Dependencies The [django-constance](https://github.com/jazzband/django-constance) library is worth checking out, though it might be overkill.
adam added the status: acceptedtype: feature labels 2025-12-29 18:38:08 +01:00
adam closed this issue 2025-12-29 18:38:08 +01:00
adam commented 2025-12-29 18:38:08 +01:00
Author
Owner
Copy Link

@bluikko commented on GitHub (Jun 28, 2021):

I hope that there will be an API or NetBox console access to those configuration parameters in the database.

Otherwise it will make containers and other automated deployments difficult: the database would need to be modified manually.

@bluikko commented on GitHub (Jun 28, 2021): I hope that there will be an API or NetBox console access to those configuration parameters in the database. Otherwise it will make containers and other automated deployments difficult: the database would need to be modified manually.
adam commented 2025-12-29 18:38:08 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 30, 2021):

Going to take a stab at implementing this for v3.0.

@jeremystretch commented on GitHub (Jun 30, 2021): Going to take a stab at implementing this for v3.0.
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 9, 2021):

After digging into this a bit, I think we need to give more thought to specifically which configuration parameters we want to expose via the UI. Every parameter unique to NetBox itself is easily handled, either using a tool like django-constance or with a custom implementation, but the stock settings defined by Django are trickier. These can't be easily modified in flight due to how Django's settings framework functions.

Many of these built-in settings are fine to keep as static values: database configuration, filesystem paths, etc. However, others are ideal candidates for control via the UI: date and time formatting, for example. I'm just not sure it's worth the effort to pursue support for these.

@jeremystretch commented on GitHub (Jul 9, 2021): After digging into this a bit, I think we need to give more thought to specifically which configuration parameters we want to expose via the UI. Every parameter unique to NetBox itself is easily handled, either using a tool like django-constance or with a custom implementation, but the stock settings defined by Django are trickier. These can't be easily modified in flight due to how Django's settings framework functions. Many of these built-in settings are fine to keep as static values: database configuration, filesystem paths, etc. However, others are ideal candidates for control via the UI: date and time formatting, for example. I'm just not sure it's worth the effort to pursue support for these.
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Sep 8, 2021):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Sep 8, 2021): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 19, 2021):

The delineation here will be between native Django settings and configuration parameters that we've introduced for NetBox specifically. By moving the later out of the settings module, we'll be able to update them dynamically without needing to restart any services.

@jeremystretch commented on GitHub (Oct 19, 2021): The delineation here will be between native Django settings and configuration parameters that we've introduced for NetBox specifically. By moving the later out of the settings module, we'll be able to update them dynamically without needing to restart any services.
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 27, 2021):

NetBox config revisions

@jeremystretch commented on GitHub (Oct 27, 2021): ![NetBox config revisions](https://user-images.githubusercontent.com/13487278/139121599-6eb33cfb-1851-42ab-b189-6ae7eb1e9cdd.gif)
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: feature
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#4600
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?