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

Undeprecate securityadmin script #4766

Merged

Conversation

derek-ho
Copy link
Contributor

@derek-ho derek-ho commented Oct 1, 2024

Description

There was some recent engagement/concern from the community (for example @spapadop) about the deprecation of security admin script. Since there is no concrete plan to remove/replace it, we should remove the deprecation warning. We can add this back in if/when we decide to and have a viable alternative for the script.

Issues Resolved

None
Is this a backport? If so, please add backport PR # and/or commits #, and remove backport-failed label from the original PR.
No

Do these changes introduce new permission(s) to be displayed in the static dropdown on the front-end? If so, please open a draft PR in the security dashboards plugin and link the draft PR here
No

Testing

Script no longer prints the warning out

Check List

  • New functionality includes testing
  • New functionality has been documented
  • New Roles/Permissions have a corresponding security dashboards plugin PR
  • API changes companion pull request created
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@derek-ho
Copy link
Contributor Author

derek-ho commented Oct 1, 2024

@peternied I saw that in your original issue you mentioned that this tool would continue to be supported through out 3.0.0. We currently don't have bandwidth to come up with an alternative, so wdyt about removing this deprecation notice until if/when we have a path forward to deprecation, to avoid community panic?

Copy link

codecov bot commented Oct 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.63%. Comparing base (df115d8) to head (6aee70d).
Report is 4 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4766      +/-   ##
==========================================
- Coverage   65.64%   65.63%   -0.01%     
==========================================
  Files         321      321              
  Lines       22539    22539              
  Branches     3611     3611              
==========================================
- Hits        14795    14793       -2     
- Misses       5932     5934       +2     
  Partials     1812     1812              

see 5 files with indirect coverage changes

@cwperks
Copy link
Member

cwperks commented Oct 1, 2024

@derek-ho wdyt about reverting all of #1756?

@derek-ho
Copy link
Contributor Author

derek-ho commented Oct 1, 2024

@derek-ho wdyt about reverting all of #1756?

Sure I can add those as well. Initially I only added securityadmin as this is the main script that folks had concerns about.

Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This warning was put into place as these tools aren't really supported - they aren't up to the quality bar we have for the rest of the security codebase - unless something has changed that I've missed?

I'll leave this to other maintainers to approve or not, but I don't think anything has changed that means these tools can be depended on by any downstream project.

@cwperks
Copy link
Member

cwperks commented Oct 1, 2024

they aren't up to the quality bar we have for the rest of the security codebase - unless something has changed that I've missed?

@peternied can you expand on this?

Now that the install_demo_configuration has moved from completely being a bash script to becoming a bash script that invokes a java program, it has become unit-testable and up to the same quality as the rest of the codebase.

Other tools in the tools folder have been receiving bug fixes and new features as well. They are actively maintained. Here's an example of a recent update to the Hasher tool: #4524

@DarshitChanpura
Copy link
Member

Let's un-deprecate these until there is a clear deprecation path and replacement in-place.

@DarshitChanpura DarshitChanpura merged commit f315c4c into opensearch-project:main Oct 1, 2024
41 of 42 checks passed
@cwperks cwperks added backport 2.x backport to 2.x branch v2.18.0 Issues targeting release v2.18.0 labels Oct 2, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 2, 2024
Signed-off-by: Derek Ho <[email protected]>
(cherry picked from commit f315c4c)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x backport to 2.x branch v2.18.0 Issues targeting release v2.18.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants