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

add plugins.removeList to allow remove plugins #526

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ruanyl
Copy link
Member

@ruanyl ruanyl commented Mar 13, 2024

Description

During the development phase, it's common to deploy a cluster with plugins that are still in progress. To facilitate the installation of these plugins, the current approach involves removing existing plugins and then installing the development versions. This process often requires manual intervention.

This pull request addresses this issue by introducing the removeList to the Helm charts. With this enhancement, we can manage the installation and removal of plugins with eliminating the need for manual intervention.

Addresses the issue described in #383, where user encountered challenges related to plugin removal.

Issues Resolved

resolved #383

Check List

  • Commits are signed per the DCO using --signoff

For any changes to files within Helm chart directories:

  • Helm chart version bumped
  • Helm chart CHANGELOG.md updated to reflect change

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.

@ruanyl ruanyl force-pushed the feature-plugin-remove-list branch from 38f9da3 to 704bc9d Compare December 23, 2024 09:30
Copy link
Member

@peterzhuamazon peterzhuamazon left a comment

Choose a reason for hiding this comment

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

Hi @ruanyl ,

Please make sure you update the changelog and versions.

And address the few comments I posted. Thanks 😄

@@ -365,6 +365,12 @@ spec:
#!/usr/bin/env bash
set -euo pipefail

{{- range $plugin := .Values.plugins.removeList }}
if ./bin/opensearch-plugin list | grep -q {{ $plugin }}; then
Copy link
Member

Choose a reason for hiding this comment

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

Why is there a different behavior b/w os and osd plugin removal?
Is it necessary to do a check before OS removal but not OSD?

Copy link
Member Author

@ruanyl ruanyl Dec 25, 2024

Choose a reason for hiding this comment

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

Thanks for catching this, we should check if the plugin installed before remove it for both OS and OSD, now the PR is updated.

@@ -278,6 +278,8 @@ plugins:
enabled: false
installList: []
# - example-fake-plugin-downloadable-url
removeList: []
# - securityDashboards
Copy link
Member

Choose a reason for hiding this comment

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

Change this to something like - examplePluginName or similar.

@@ -491,6 +491,8 @@ plugins:
enabled: false
installList: []
# - example-fake-plugin
removeList: []
# - opensearch-ml
Copy link
Member

Choose a reason for hiding this comment

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

same as above.

@ruanyl
Copy link
Member Author

ruanyl commented Dec 25, 2024

Hi @ruanyl ,

Please make sure you update the changelog and versions.

And address the few comments I posted. Thanks 😄

Thank you for the guidance, this is the first time I make change to this repo, I followed some other PRs on how to bump the version and update the change logs, let me know if I missed anything :D

@@ -14,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
### Security
---
## [2.26.0]
Copy link
Member

Choose a reason for hiding this comment

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

Please also update the links at the end of the changelog

Copy link
Member Author

Choose a reason for hiding this comment

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

I see, now updated, I thought it's something automatically generated :D

@@ -14,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
### Security
---
## [2.29.0]
Copy link
Member

Choose a reason for hiding this comment

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

Same as above

Signed-off-by: Yulong Ruan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 📦 Backlog
Development

Successfully merging this pull request may close these issues.

[Enhancement][OpenSearch Dashboards] Disable or remove plugins
2 participants