[backport 1.x]: added plugins.removeList to allow remove plugins (#640)

* backport: added plugins.removeList to allow remove plugins --- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * fix(changelog): fix ref compare url Signed-off-by: Yulong Ruan <ruanyl@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com>
opensearch-project · Jan 7, 2025 · b27abdd · b27abdd
1 parent cb60739
commit b27abdd
Show file tree

Hide file tree

Showing 8 changed files with 92 additions and 57 deletions.
diff --git a/charts/opensearch-dashboards/CHANGELOG.md b/charts/opensearch-dashboards/CHANGELOG.md
@@ -14,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 ---
+## [1.26.0]
+### Added
+- Added plugins.removeList to allow remove plugins
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+---
 ## [1.25.0]
 ### Added
 ### Changed
@@ -498,58 +507,59 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.25.0...HEAD
-[1.25.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.24.1...opensearch-1.25.0
-[1.24.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.24.0...opensearch-1.24.1
-[1.24.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.23.0...opensearch-1.24.0
-[1.23.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.22.0...opensearch-1.23.0
-[1.22.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.21.0...opensearch-1.22.0
-[1.21.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.20.0...opensearch-1.21.0
-[1.20.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.19.0...opensearch-1.20.0
-[1.19.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.18.0...opensearch-1.19.0
-[1.18.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.17.0...opensearch-1.18.0
-[1.17.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.16.0...opensearch-1.17.0
-[1.16.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.15.0...opensearch-1.16.0
-[1.15.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.14.0...opensearch-1.15.0
-[1.14.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.13.1...opensearch-1.14.0
-[1.13.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.13.0...opensearch-1.13.1
-[1.13.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.12.2...opensearch-1.13.0
-[1.12.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.12.1...opensearch-1.12.2
-[1.12.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.12.0...opensearch-1.12.1
-[1.12.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.11.1...opensearch-1.12.0
-[1.11.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.11.0...opensearch-1.11.1
-[1.11.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.10.0...opensearch-1.11.0
-[1.10.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.9.1...opensearch-1.10.0
-[1.9.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.9.0...opensearch-1.9.1
-[1.9.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.8.4...opensearch-1.9.0
-[1.8.4]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.8.3...opensearch-1.8.4
-[1.8.3]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.8.2...opensearch-1.8.3
-[1.8.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.8.1...opensearch-1.8.2
-[1.8.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.8.0...opensearch-1.8.1
-[1.8.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.7.4...opensearch-1.8.0
-[1.7.4]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.7.3...opensearch-1.7.4
-[1.7.3]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.7.2...opensearch-1.7.3
-[1.7.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.7.1...opensearch-1.7.2
-[1.7.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.7.0...opensearch-1.7.1
-[1.7.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.6.1...opensearch-1.7.0
-[1.6.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.6.0...opensearch-1.6.1
-[1.6.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.5.1...opensearch-1.6.0
-[1.5.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.4.1...opensearch-1.5.1
-[1.4.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.4.0...opensearch-1.4.1
-[1.4.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.3.3...opensearch-1.4.0
-[1.3.3]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.3.2...opensearch-1.3.3
-[1.3.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.3.1...opensearch-1.3.2
-[1.3.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.3.0...opensearch-1.3.1
-[1.3.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.2.2...opensearch-1.3.0
-[1.2.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.2.1...opensearch-1.2.2
-[1.2.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.2.0...opensearch-1.2.1
-[1.2.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.1.2...opensearch-1.2.0
-[1.1.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.1.1...opensearch-1.1.2
-[1.1.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.1.0...opensearch-1.1.1
-[1.1.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.8...opensearch-1.1.0
-[1.0.8]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.7...opensearch-1.0.8
-[1.0.7]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.6...opensearch-1.0.7
-[1.0.6]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.5...opensearch-1.0.6
-[1.0.5]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.4...opensearch-1.0.5
-[1.0.4]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.2...opensearch-1.0.4
+[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.26.0...HEAD
+[1.26.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.25.0...opensearch-dashboards-1.26.0
+[1.25.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.24.1...opensearch-dashboards-1.25.0
+[1.24.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.24.0...opensearch-dashboards-1.24.1
+[1.24.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.23.0...opensearch-dashboards-1.24.0
+[1.23.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.22.0...opensearch-dashboards-1.23.0
+[1.22.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.21.0...opensearch-dashboards-1.22.0
+[1.21.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.20.0...opensearch-dashboards-1.21.0
+[1.20.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.19.0...opensearch-dashboards-1.20.0
+[1.19.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.18.0...opensearch-dashboards-1.19.0
+[1.18.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.17.0...opensearch-dashboards-1.18.0
+[1.17.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.16.0...opensearch-dashboards-1.17.0
+[1.16.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.15.0...opensearch-dashboards-1.16.0
+[1.15.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.14.0...opensearch-dashboards-1.15.0
+[1.14.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.13.1...opensearch-dashboards-1.14.0
+[1.13.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.13.0...opensearch-dashboards-1.13.1
+[1.13.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.12.2...opensearch-dashboards-1.13.0
+[1.12.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.12.1...opensearch-dashboards-1.12.2
+[1.12.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.12.0...opensearch-dashboards-1.12.1
+[1.12.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.11.1...opensearch-dashboards-1.12.0
+[1.11.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.11.0...opensearch-dashboards-1.11.1
+[1.11.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.10.0...opensearch-dashboards-1.11.0
+[1.10.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.9.1...opensearch-dashboards-1.10.0
+[1.9.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.9.0...opensearch-dashboards-1.9.1
+[1.9.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.8.4...opensearch-dashboards-1.9.0
+[1.8.4]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.8.3...opensearch-dashboards-1.8.4
+[1.8.3]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.8.2...opensearch-dashboards-1.8.3
+[1.8.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.8.1...opensearch-dashboards-1.8.2
+[1.8.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.8.0...opensearch-dashboards-1.8.1
+[1.8.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.7.4...opensearch-dashboards-1.8.0
+[1.7.4]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.7.3...opensearch-dashboards-1.7.4
+[1.7.3]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.7.2...opensearch-dashboards-1.7.3
+[1.7.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.7.1...opensearch-dashboards-1.7.2
+[1.7.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.7.0...opensearch-dashboards-1.7.1
+[1.7.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.6.1...opensearch-dashboards-1.7.0
+[1.6.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.6.0...opensearch-dashboards-1.6.1
+[1.6.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.5.1...opensearch-dashboards-1.6.0
+[1.5.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.4.1...opensearch-dashboards-1.5.1
+[1.4.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.4.0...opensearch-dashboards-1.4.1
+[1.4.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.3.3...opensearch-dashboards-1.4.0
+[1.3.3]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.3.2...opensearch-dashboards-1.3.3
+[1.3.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.3.1...opensearch-dashboards-1.3.2
+[1.3.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.3.0...opensearch-dashboards-1.3.1
+[1.3.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.2.2...opensearch-dashboards-1.3.0
+[1.2.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.2.1...opensearch-dashboards-1.2.2
+[1.2.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.2.0...opensearch-dashboards-1.2.1
+[1.2.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.1.2...opensearch-dashboards-1.2.0
+[1.1.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.1.1...opensearch-dashboards-1.1.2
+[1.1.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.1.0...opensearch-dashboards-1.1.1
+[1.1.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.8...opensearch-dashboards-1.1.0
+[1.0.8]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.7...opensearch-dashboards-1.0.8
+[1.0.7]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.6...opensearch-dashboards-1.0.7
+[1.0.6]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.5...opensearch-dashboards-1.0.6
+[1.0.5]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.4...opensearch-dashboards-1.0.5
+[1.0.4]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.2...opensearch-dashboards-1.0.4
 [1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.1...opensearch-dashboards-1.0.2
diff --git a/charts/opensearch-dashboards/Chart.yaml b/charts/opensearch-dashboards/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.25.0
+version: 1.26.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/opensearch-dashboards/templates/deployment.yaml b/charts/opensearch-dashboards/templates/deployment.yaml
@@ -165,6 +165,11 @@ spec:
           - |
             #!/usr/bin/bash
             set -e
+            {{- range $plugin := .Values.plugins.removeList }}
+            if ./bin/opensearch-dashboards-plugin list | grep -q {{ $plugin }}; then
+              ./bin/opensearch-dashboards-plugin remove {{ $plugin }}
+            fi
+            {{- end }}
             {{- range $plugin := .Values.plugins.installList }}
             ./bin/opensearch-dashboards-plugin install {{ $plugin }}
             {{- end }}

diff --git a/charts/opensearch-dashboards/values.yaml b/charts/opensearch-dashboards/values.yaml
@@ -272,6 +272,8 @@ plugins:
   enabled: false
   installList: []
   # - example-fake-plugin-downloadable-url
+  removeList: []
+  # - examplePluginName
 
 # ServiceMonitor Configuration for Prometheus
 # Enabling this option will create a ServiceMonitor resource that allows Prometheus to scrape metrics from the OpenSearch service.

diff --git a/charts/opensearch/CHANGELOG.md b/charts/opensearch/CHANGELOG.md
@@ -14,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 ---
+## [1.35.0]
+### Added
+- Added plugins.removeList to allow remove plugins
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+---
 ## [1.34.0]
 ### Added
 - Ability to set a basic auth configuration to the `serviceMonitor`
@@ -769,7 +778,8 @@ config:
 ### Fixed
 ### Security
 
-[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.34.0...HEAD
+[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.35.0...HEAD
+[1.35.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.34.0...opensearch-1.35.0
 [1.34.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.34.0...opensearch-1.33.0
 [1.33.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.32.0...opensearch-1.33.0
 [1.32.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.31.2...opensearch-1.32.0

diff --git a/charts/opensearch/Chart.yaml b/charts/opensearch/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.34.0
+version: 1.35.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/opensearch/templates/statefulset.yaml b/charts/opensearch/templates/statefulset.yaml
@@ -331,6 +331,12 @@ spec:
           #!/usr/bin/env bash
           set -euo pipefail
 
+          {{- range $plugin := .Values.plugins.removeList }}
+          if ./bin/opensearch-plugin list | grep -q {{ $plugin }}; then
+          ./bin/opensearch-plugin remove {{ $plugin }}
+          fi
+          {{- end }}
+
           {{- range $plugin := .Values.plugins.installList }}
           ./bin/opensearch-plugin install -b {{ $plugin }}
           {{- end }}

diff --git a/charts/opensearch/values.yaml b/charts/opensearch/values.yaml
@@ -471,6 +471,8 @@ plugins:
   enabled: false
   installList: []
   # - example-fake-plugin
+  removeList: []
+  # - example-fake-plugin
 
 # -- Array of extra K8s manifests to deploy
 extraObjects: []