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 secrets to an official plugin #4219

New Issue
Closed
opened 2025-12-29 18:33:56 +01:00 by adam · 13 comments
adam commented 2025-12-29 18:33:56 +01:00
Owner
Copy Link

Originally created by @DanSheps on GitHub (Oct 27, 2020).

Originally assigned to: @DanSheps on GitHub.

Environment

  • Python version: 3.7
  • NetBox version: 2.9.7

Proposed Functionality

Move the secrets app to a dedicated official plugin

Use Case

There have been a few requests to improve the secrets functionality or to allow integration into a third party secret vault (HashiCorp, etc). Additionally, we have a naming collision with the "secrets" python standard library (#4553). Moving the secrets app into a dedicated plugin would allow us to:

  • Rename the plugin app to resolve the naming collision with the python standard library
  • Increase the ease of updating and modifying the secrets plugin
  • Provide a plugin to showcase the capabilities of the NetBox plugins framework
  • Provide a plugin to test against for issues with the plugins framework
  • Allow plugin developers to integrate their own secret plugins

Database Changes

Table changes to accommodate moving the app to a official plugin

External Dependencies

None

Originally created by @DanSheps on GitHub (Oct 27, 2020). Originally assigned to: @DanSheps on GitHub. ### Environment * Python version: 3.7 * NetBox version: 2.9.7 ### Proposed Functionality Move the secrets app to a dedicated official plugin ### Use Case There have been a few requests to improve the secrets functionality or to allow integration into a third party secret vault (HashiCorp, etc). Additionally, we have a naming collision with the "secrets" python standard library (#4553). Moving the secrets app into a dedicated plugin would allow us to: * Rename the plugin app to resolve the naming collision with the python standard library * Increase the ease of updating and modifying the secrets plugin * Provide a plugin to showcase the capabilities of the NetBox plugins framework * Provide a plugin to test against for issues with the plugins framework * Allow plugin developers to integrate their own secret plugins ### Database Changes Table changes to accommodate moving the app to a official plugin ### External Dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 18:33:56 +01:00
adam closed this issue 2025-12-29 18:33:56 +01:00
adam commented 2025-12-29 18:33:57 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Dec 12, 2020):

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.

@stale[bot] commented on GitHub (Dec 12, 2020): 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:33:57 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Dec 16, 2020):

Provide a plugin to test against for issues with the plugins framework

Just want to note that we have this already: There's a dummy_plugin plugin buried within the extras app that's enabled and configured solely for testing. Tests intended to run against a production plugin would probably be too difficult to maintain.

@jeremystretch commented on GitHub (Dec 16, 2020): > Provide a plugin to test against for issues with the plugins framework Just want to note that we have this already: There's a `dummy_plugin` plugin buried within the `extras` app that's enabled and configured solely for testing. Tests intended to run against a production plugin would probably be too difficult to maintain.
adam commented 2025-12-29 18:33:57 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Jan 31, 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.

@stale[bot] commented on GitHub (Jan 31, 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:33:57 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 7, 2021):

This is something we can keep in mind for the future, but for the time being it's not something worth the necessary commitment of time and effort.

@jeremystretch commented on GitHub (Feb 7, 2021): This is something we can keep in mind for the future, but for the time being it's not something worth the necessary commitment of time and effort.
adam commented 2025-12-29 18:33:57 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 25, 2021):

Reopening this for @DanSheps.

@jeremystretch commented on GitHub (Feb 25, 2021): Reopening this for @DanSheps.
adam commented 2025-12-29 18:33:57 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Mar 17, 2021):

Removal is staged in https://github.com/netbox-community/netbox/tree/feature-remove-secrets

Plugin is still being developed.

@DanSheps commented on GitHub (Mar 17, 2021): Removal is staged in https://github.com/netbox-community/netbox/tree/feature-remove-secrets Plugin is still being developed.
adam commented 2025-12-29 18:33:58 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 26, 2021):

@DanSheps and I decided to push this back (slightly) to the v2.12 release. This ensures a quicker release for v2.11, and provides more warning time for users of the secrets functionality.

@jeremystretch commented on GitHub (Mar 26, 2021): @DanSheps and I decided to push this back (slightly) to the v2.12 release. This ensures a quicker release for v2.11, and provides more warning time for users of the secrets functionality.
adam commented 2025-12-29 18:33:58 +01:00
Author
Owner
Copy Link

@jameskirsop commented on GitHub (May 6, 2021):

@DanSheps, do you have an update on the plugin? I'd be interested to see it and start working towards implementing something to address #4980 using the official plugin if possible, so that when v2.12 drops we could include this feature at the same time.

@jameskirsop commented on GitHub (May 6, 2021): @DanSheps, do you have an update on the plugin? I'd be interested to see it and start working towards implementing something to address #4980 using the _official_ plugin if possible, so that when v2.12 drops we could include this feature at the same time.
adam commented 2025-12-29 18:33:58 +01:00
Author
Owner
Copy Link

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

Closing out this issue as the secrets code has been removed from NetBox core. Work is still underway on the plugin.

@jeremystretch commented on GitHub (Jul 13, 2021): Closing out this issue as the secrets code has been removed from NetBox core. Work is still underway on the plugin.
adam commented 2025-12-29 18:33:58 +01:00
Author
Owner
Copy Link

@twexler commented on GitHub (Aug 23, 2021):

@jeremystretch is there an issue or repo one can use to track the work on the secrets plugin?

@twexler commented on GitHub (Aug 23, 2021): @jeremystretch is there an issue or repo one can use to track the work on the secrets plugin?
adam commented 2025-12-29 18:33:58 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 23, 2021):

@DanSheps has been working on it here: https://github.com/DanSheps/netbox-secretstore

@jeremystretch commented on GitHub (Aug 23, 2021): @DanSheps has been working on it here: https://github.com/DanSheps/netbox-secretstore
adam commented 2025-12-29 18:33:58 +01:00
Author
Owner
Copy Link

@n3bojs4 commented on GitHub (Sep 17, 2021):

Hello !
In my humble opinion, a plugin for hashicorp vault would be a real killer.

@n3bojs4 commented on GitHub (Sep 17, 2021): Hello ! In my humble opinion, a plugin for hashicorp vault would be a real killer.
adam commented 2025-12-29 18:33:58 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Sep 22, 2021):

In my humble opinion, a plugin for hashicorp vault would be a real killer.

you are free to develop one yourself.

Unfortunately this issue is specifically for deprecating secrets.

@DanSheps commented on GitHub (Sep 22, 2021): > In my humble opinion, a plugin for hashicorp vault would be a real killer. you are free to develop one yourself. Unfortunately this issue is specifically for deprecating secrets.
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#4219
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?