Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move secrets to an official plugin #5278

Closed
DanSheps opened this issue Oct 27, 2020 · 13 comments
Closed

Move secrets to an official plugin #5278

DanSheps opened this issue Oct 27, 2020 · 13 comments
Assignees
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Milestone

Comments

@DanSheps
Copy link
Member

DanSheps commented Oct 27, 2020

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

@DanSheps DanSheps added API change needs milestone Awaiting prioritization for inclusion with a future NetBox release type: feature Introduction of new functionality to the application status: under review Further discussion is needed to determine this issue's scope and/or implementation and removed needs milestone Awaiting prioritization for inclusion with a future NetBox release labels Oct 27, 2020
@stale
Copy link

stale bot commented 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 stale bot added the pending closure Requires immediate attention to avoid being closed for inactivity label Dec 12, 2020
@jeremystretch
Copy link
Member

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.

@stale stale bot removed the pending closure Requires immediate attention to avoid being closed for inactivity label Dec 16, 2020
@stale
Copy link

stale bot commented 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 stale bot added the pending closure Requires immediate attention to avoid being closed for inactivity label Jan 31, 2021
@jeremystretch
Copy link
Member

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 jeremystretch removed the pending closure Requires immediate attention to avoid being closed for inactivity label Feb 7, 2021
@jeremystretch
Copy link
Member

Reopening this for @DanSheps.

@jeremystretch jeremystretch reopened this Feb 25, 2021
@DanSheps DanSheps added status: accepted This issue has been accepted for implementation and removed status: under review Further discussion is needed to determine this issue's scope and/or implementation labels Mar 10, 2021
@DanSheps DanSheps added this to the v2.11 milestone Mar 17, 2021
@DanSheps
Copy link
Member Author

DanSheps commented Mar 17, 2021

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

Plugin is still being developed.

@jeremystretch jeremystretch modified the milestones: v2.11, v2.12 Mar 26, 2021
@jeremystretch
Copy link
Member

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

@jameskirsop
Copy link

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

jeremystretch pushed a commit that referenced this issue May 17, 2021
* Remove Secrets

* #5278: Remove secrets javascript from netbox core

* Remove userkey references

* Fix PEP8

* Remove a few more instances of secrets.  Rebundle

* Remove Secrets

Co-authored-by: checktheroads <matt@allroads.io>
@jeremystretch
Copy link
Member

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

@twexler
Copy link

twexler commented Aug 23, 2021

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

@jeremystretch
Copy link
Member

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

@n3bojs4
Copy link

n3bojs4 commented Sep 17, 2021

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

@DanSheps
Copy link
Member Author

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.

@netbox-community netbox-community locked as resolved and limited conversation to collaborators Sep 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Development

No branches or pull requests

5 participants