allow adding plugins and change defaultmode for opensearch dashboards #342

BionIT · 2022-10-27T23:11:42Z

Description

Similar to #71 , the change would allow installing external plugins when container starts for opensearch dashboards.
In addition, this change allows to specify defaultMode for the opensearch_dashboards.yml file which is mounted as configmap
Changelog and Readme are updated.
Changes were tested using k8s cluster using the chart

Issues Resolved

#341

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.

… yaml file Signed-off-by: Lu Yu <[email protected]>

TheAlgo

@BionIT Can you refactor the PR according to contribution guidelines mentioned in CONTRIBUTING.md

BionIT · 2022-10-28T17:59:40Z

@BionIT Can you refactor the PR according to contribution guidelines mentioned in CONTRIBUTING.md

@TheAlgo Sure! Do we need to bump appVersion from 2.3.0 to 2.3.1 as well or just version? The linked PR did both, but OSD latest release is at 2.3.0

peterzhuamazon · 2022-10-28T22:21:57Z

@BionIT Can you refactor the PR according to contribution guidelines mentioned in CONTRIBUTING.md

@TheAlgo Sure! Do we need to bump appVersion from 2.3.0 to 2.3.1 as well or just version? The linked PR did both, but OSD latest release is at 2.3.0

appversion keep 2.3.0, just bump version.

Signed-off-by: Lu Yu <[email protected]>

BionIT · 2022-10-28T23:56:34Z

@BionIT Can you refactor the PR according to contribution guidelines mentioned in CONTRIBUTING.md

@TheAlgo Sure! Do we need to bump appVersion from 2.3.0 to 2.3.1 as well or just version? The linked PR did both, but OSD latest release is at 2.3.0

appversion keep 2.3.0, just bump version.

Thanks @peterzhuamazon and @TheAlgo ! I have bumped version for osd chart, linter was complaining about version bump for os, but I only updated documentation for os chart, and per CONTRIBUTING.md: Chart version should be bumped for every code change except docoumentation change. Please let me know if any advice~

TheAlgo · 2022-10-29T06:41:18Z

@BionIT Can you refactor the PR according to contribution guidelines mentioned in CONTRIBUTING.md

@TheAlgo Sure! Do we need to bump appVersion from 2.3.0 to 2.3.1 as well or just version? The linked PR did both, but OSD latest release is at 2.3.0

appversion keep 2.3.0, just bump version.

Thanks @peterzhuamazon and @TheAlgo ! I have bumped version for osd chart, linter was complaining about version bump for os, but I only updated documentation for os chart, and per CONTRIBUTING.md: Chart version should be bumped for every code change except docoumentation change. Please let me know if any advice~

Yes this is not ideal but this is a backlog for this repo. Our linter is configured this way. @prudhvigodithi / @peterzhuamazon We need to fix this ASAP. In the meanwhile @BionIT can you bump minor version for OS chart as well so that linter is happy

Signed-off-by: Lu Yu <[email protected]>

BionIT · 2022-10-29T21:35:05Z

@BionIT Can you refactor the PR according to contribution guidelines mentioned in CONTRIBUTING.md

@TheAlgo Sure! Do we need to bump appVersion from 2.3.0 to 2.3.1 as well or just version? The linked PR did both, but OSD latest release is at 2.3.0

appversion keep 2.3.0, just bump version.

Thanks @peterzhuamazon and @TheAlgo ! I have bumped version for osd chart, linter was complaining about version bump for os, but I only updated documentation for os chart, and per CONTRIBUTING.md: Chart version should be bumped for every code change except docoumentation change. Please let me know if any advice~

Yes this is not ideal but this is a backlog for this repo. Our linter is configured this way. @prudhvigodithi / @peterzhuamazon We need to fix this ASAP. In the meanwhile @BionIT can you bump minor version for OS chart as well so that linter is happy

Sure, @TheAlgo! Thanks for clarifying! I have bumped version for os chart as well and the linter is happy now :).

TheAlgo · 2022-11-03T17:59:36Z

charts/opensearch-dashboards/templates/deployment.yaml

@@ -47,6 +47,9 @@ spec:
        - name: config
          configMap:
            name: {{ template "opensearch-dashboards.fullname" . }}-config
+            {{- if .Values.opensearchDashboardsYml.defaultMode }}


Can we use some other intuitive name here. I don't mind directly adding defaultMode as well. @prudhvigodithi @DandyDeveloper @peterzhuamazon Opinions?

There are multiple configmaps, and I think being explicit would help if we introduce more custom configurations about defaultmode for those configmaps. Open to a better naming if we have any

@prudhvigodithi ^^

peterzhuamazon · 2022-11-12T06:24:30Z

Adding @prudhvigodithi to take a look at this.

TheAlgo · 2022-11-19T17:52:04Z

@prudhvigodithi @DandyDeveloper Please take a look when free. Thanks

seanneumann · 2022-11-23T00:26:18Z

Heya, what's the latest on getting this reviewed? I'd like to get this merged.

prudhvigodithi · 2022-11-23T16:29:23Z

charts/opensearch-dashboards/templates/deployment.yaml

+            set -e
+            {{- range $plugin := .Values.plugins.installList }}
+            ./bin/opensearch-dashboards-plugin install {{ $plugin }}
+            {{- end }}


Hey @BionIT quick question, for OpenSearch we have a --batch option to force install without a prompt, is there a same flag or scenario for opensearch-dashboards-plugin, I dont see it in the document though https://opensearch.org/docs/latest/dashboards/install/plugins/, please test this and share your update.

Hey @prudhvigodithi, --batch is not supported by opensearch-dashboards-plugin(error: unknown option '--batch' ), I have been using this script to install plugins and never had prompts.

prudhvigodithi · 2022-11-23T16:30:10Z

Hey @BionIT thanks for the PR and contribution, please check the following points.

Adding default mode is not a bad idea but can you share what issues faced for this to get added, if not lets keep what kubernetes sets to the defaultMode to the volume.
~~- Since the change is particular to the OpenSearch Dashboard, we dont have to increment the versions in chart.yaml for OpenSearch, only for the dashboard chart is required.~~
Can you also please resolve the conflicts?

@TheAlgo @DandyDeveloper @peterzhuamazon @bbarani @seraphjiang

Signed-off-by: Lu Yu <[email protected]>

BionIT · 2022-11-25T18:56:05Z

Hey @BionIT thanks for the PR and contribution, please check the following points.

Adding default mode is not a bad idea but can you share what issues faced for this to get added, if not lets keep what kubernetes sets to the defaultMode to the volume.
~~- Since the change is particular to the OpenSearch Dashboard, we dont have to increment the versions in chart.yaml for OpenSearch, only for the dashboard chart is required.~~

Can you also please resolve the conflicts?

@TheAlgo @DandyDeveloper @peterzhuamazon @bbarani @seraphjiang

Per request, resolved conflicts.
Per allowing users to set defaultMode, k8s allow users to specify defaultmode for volumes, why our helm chart want to restrict it to readonly? We have use case to dynamically change the values in the yaml and the current set up prevents that.

Signed-off-by: Lu Yu <[email protected]>

peterzhuamazon · 2022-11-30T19:41:03Z

Pinging @DandyDeveloper @TheAlgo @prudhvigodithi again for the checks on @BionIT latest changes.
I am ok with this approach, and if any of you give an approval we can follow up with a merge.

Thanks.

peterzhuamazon

Approved, thanks for being patient on this.
@rishabh6788 please approve.

Thanks.

peterzhuamazon · 2022-12-07T20:06:56Z

Trying to fix the issues with linting.

peterzhuamazon · 2022-12-07T20:13:33Z

Related to kind action need to update to 1.3.0.

[BUG] Kind Creation Failing in the PR Checks Runs #355

Resolved now.

peterzhuamazon · 2022-12-08T18:01:26Z

Hi @BionIT please have a follow-up backport PR to 1.x.
Thanks.

peterzhuamazon · 2022-12-08T19:04:33Z

Backport 1.x: #359

…opensearch-project#342) * allow adding plugins and change defaultmode for opensearch dashboards yaml file Signed-off-by: Lu Yu <[email protected]> * bump version and update changelog Signed-off-by: Lu Yu <[email protected]> * add new line Signed-off-by: Lu Yu <[email protected]> * bump version for os Signed-off-by: Lu Yu <[email protected]> * resolve conflict in changelog Signed-off-by: Lu Yu <[email protected]> * trigger build Signed-off-by: Lu Yu <[email protected]> Signed-off-by: Lu Yu <[email protected]> Co-authored-by: Peter Zhu <[email protected]> Signed-off-by: prathaptce <[email protected]>

* Update appVersion for 2.4.0 release (#350) Signed-off-by: Zelin Hao <[email protected]> Signed-off-by: Zelin Hao <[email protected]> Signed-off-by: prathaptce <[email protected]> * Add .whitesource configuration file (#353) Co-authored-by: mend-for-github.aaakk.us.kg[bot] <50673670+mend-for-github.aaakk.us.kg[bot]@users.noreply.github.com> Signed-off-by: prathaptce <[email protected]> * Resolve Kind Cluster not able to be built in PR checks (#356) Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: prathaptce <[email protected]> * Fix the kindest/node docker images versions (#357) * Resolve Kind Cluster not able to be built in PR checks Signed-off-by: Peter Zhu <[email protected]> * Fix the kindest/node versions on docker images Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: prathaptce <[email protected]> * Resolve Kind Cluster not able to be built in PR checks (#358) Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: prathaptce <[email protected]> * allow adding plugins and change defaultmode for opensearch dashboards (#342) * allow adding plugins and change defaultmode for opensearch dashboards yaml file Signed-off-by: Lu Yu <[email protected]> * bump version and update changelog Signed-off-by: Lu Yu <[email protected]> * add new line Signed-off-by: Lu Yu <[email protected]> * bump version for os Signed-off-by: Lu Yu <[email protected]> * resolve conflict in changelog Signed-off-by: Lu Yu <[email protected]> * trigger build Signed-off-by: Lu Yu <[email protected]> Signed-off-by: Lu Yu <[email protected]> Co-authored-by: Peter Zhu <[email protected]> Signed-off-by: prathaptce <[email protected]> * Fix path in securityConfig section on OpenSearch (values.yaml) (#344) * fix securityConfig.path Signed-off-by: Ruslan Gainanov <[email protected]> * add link to issue Signed-off-by: Ruslan Gainanov <[email protected]> Signed-off-by: Ruslan Gainanov <[email protected]> Co-authored-by: Peter Zhu <[email protected]> Signed-off-by: prathaptce <[email protected]> * Update appVersion to 2.4.1 (#363) * Update appVersion to 2.4.1 Signed-off-by: Sayali Gaikawad <[email protected]> * Update appVersion to 2.4.1 Signed-off-by: Sayali Gaikawad <[email protected]> * Fix changelog Signed-off-by: Sayali Gaikawad <[email protected]> * Fix changelog Signed-off-by: Sayali Gaikawad <[email protected]> * Fix version Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: prathaptce <[email protected]> * Fix version for OpenSearch Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: prathaptce <[email protected]> * Fix version for OpenSearch-Dasboards Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: prathaptce <[email protected]> * Add hostPort support for http- and transport-ports (#336) Signed-off-by: Christian Kuhn <[email protected]> Signed-off-by: prathaptce <[email protected]> * Updated MAINTAINERS.md to match recommended opensearch-project format. (#367) Signed-off-by: dblock <[email protected]> Signed-off-by: dblock <[email protected]> Signed-off-by: prathaptce <[email protected]> * Bump OS and OSD version to 2.5.0 (#373) Signed-off-by: Rishabh Singh <[email protected]> Signed-off-by: Rishabh Singh <[email protected]> Signed-off-by: prathaptce <[email protected]> * Created untriaged issue workflow. (#382) Signed-off-by: dblock <[email protected]> Signed-off-by: prathaptce <[email protected]> * Bump OpenSearch and Dashboards to 2.6.0 (#393) Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: prathaptce <[email protected]> * Updating the CODEOWNERS file (#399) Signed-off-by: bbarani <[email protected]> Signed-off-by: prathaptce <[email protected]> * Add lifecycle support in opensearch container (#376) * Add lifecycle support in opensearch container Signed-off-by: josephteddick <[email protected]> * lifecycle support PR cleanup Signed-off-by: josephteddick <[email protected]> --------- Signed-off-by: josephteddick <[email protected]> Signed-off-by: prathaptce <[email protected]> * feat: Add user-defined labels option to ingress (#390) Signed-off-by: Jason Witkowski <[email protected]> Co-authored-by: Jason Witkowski <[email protected]> Signed-off-by: prathaptce <[email protected]> * Update deployment.yaml Signed-off-by: prathaptce <[email protected]> * Update values.yaml Signed-off-by: prathaptce <[email protected]> * Update values.yaml Signed-off-by: prathaptce <[email protected]> * Update statefulset.yaml Signed-off-by: prathaptce <[email protected]> * Updating chart version and changelog.md Signed-off-by: Prathap Mahalingam (Nokia) <[email protected]> Signed-off-by: prathaptce <[email protected]> * Add lifecycle support in opensearch container (#376) * Add lifecycle support in opensearch container Signed-off-by: josephteddick <[email protected]> * lifecycle support PR cleanup Signed-off-by: josephteddick <[email protected]> --------- Signed-off-by: josephteddick <[email protected]> Signed-off-by: prathaptce <[email protected]> * Add github-merit-badger.yml (#408) Signed-off-by: Prudhvi Godithi <[email protected]> Signed-off-by: prathaptce <[email protected]> * Service port for performance analyzer (#346) * Performance analyzer port mapping Signed-off-by: Philipp Hölscher <[email protected]> * Performance analyzer port on ci-values Signed-off-by: Philipp Hölscher <[email protected]> * Update changelog Signed-off-by: Peter Zhu <[email protected]> --------- Signed-off-by: Philipp Hölscher <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Peter Zhu <[email protected]> Signed-off-by: prathaptce <[email protected]> * Incorporated the review comments Signed-off-by: prathaptce <[email protected]> * Update values.yaml Signed-off-by: prathaptce <[email protected]> * Incorporated the review comments Signed-off-by: prathaptce <[email protected]> * Correcting the merge conflicts Signed-off-by: prathaptce <[email protected]> * Updated the README.md for OpenSearch & Dashboard Signed-off-by: prathaptce <[email protected]> * Updated the changelog message Signed-off-by: prathaptce <[email protected]> * Updating the version number Signed-off-by: prathaptce <[email protected]> --------- Signed-off-by: Zelin Hao <[email protected]> Signed-off-by: prathaptce <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: Lu Yu <[email protected]> Signed-off-by: Ruslan Gainanov <[email protected]> Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: Christian Kuhn <[email protected]> Signed-off-by: dblock <[email protected]> Signed-off-by: Rishabh Singh <[email protected]> Signed-off-by: bbarani <[email protected]> Signed-off-by: josephteddick <[email protected]> Signed-off-by: Jason Witkowski <[email protected]> Signed-off-by: Prathap Mahalingam (Nokia) <[email protected]> Signed-off-by: Prudhvi Godithi <[email protected]> Signed-off-by: Philipp Hölscher <[email protected]> Co-authored-by: Zelin Hao <[email protected]> Co-authored-by: mend-for-github.aaakk.us.kg[bot] <50673670+mend-for-github.aaakk.us.kg[bot]@users.noreply.github.com> Co-authored-by: Peter Zhu <[email protected]> Co-authored-by: Lu Yu <[email protected]> Co-authored-by: Ruslan Gainanov <[email protected]> Co-authored-by: Sayali Gaikawad <[email protected]> Co-authored-by: Sayali Gaikawad <[email protected]> Co-authored-by: Christian Kuhn <[email protected]> Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]> Co-authored-by: Rishabh Singh <[email protected]> Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]> Co-authored-by: Barani <[email protected]> Co-authored-by: Joseph Teddick <[email protected]> Co-authored-by: Jason Witkowski <[email protected]> Co-authored-by: Jason Witkowski <[email protected]> Co-authored-by: Prudhvi Godithi <[email protected]> Co-authored-by: Philipp Hölscher <[email protected]>

allow adding plugins and change defaultmode for opensearch dashboards…

361dbf8

… yaml file Signed-off-by: Lu Yu <[email protected]>

BionIT requested review from a team, TheAlgo and DandyDeveloper as code owners October 27, 2022 23:11

BionIT mentioned this pull request Oct 27, 2022

[OpenSearch Playground] Add Google analytics to playground opensearch-project/dashboards-anywhere#86

Closed

2 tasks

TheAlgo previously requested changes Oct 28, 2022

View reviewed changes

BionIT added 2 commits October 28, 2022 16:41

bump version and update changelog

2c73e00

Signed-off-by: Lu Yu <[email protected]>

add new line

ef9d771

Signed-off-by: Lu Yu <[email protected]>

bump version for os

2f43456

Signed-off-by: Lu Yu <[email protected]>

TheAlgo reviewed Nov 3, 2022

View reviewed changes

prudhvigodithi reviewed Nov 23, 2022

View reviewed changes

BionIT added 2 commits November 25, 2022 10:39

resolve conflict and bump version again

c32b91c

Signed-off-by: Lu Yu <[email protected]>

resolve conflict in changelog

154db6b

Signed-off-by: Lu Yu <[email protected]>

trigger build

222f5c7

Signed-off-by: Lu Yu <[email protected]>

rishabh6788 approved these changes Dec 7, 2022

View reviewed changes

peterzhuamazon approved these changes Dec 7, 2022

View reviewed changes

Merge remote-tracking branch 'upstream/main' into additionalconfig

206393f

peterzhuamazon added 3 commits December 7, 2022 15:42

Merge remote-tracking branch 'upstream/main' into additionalconfig

351443b

Merge remote-tracking branch 'upstream/main' into additionalconfig

dbebae0

Merge remote-tracking branch 'upstream/main' into additionalconfig

16212d7

peterzhuamazon merged commit 867d5fd into opensearch-project:main Dec 8, 2022

BionIT mentioned this pull request Dec 8, 2022

[Backport 1.x]allow adding plugins and change defaultmode for opensea… #361

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allow adding plugins and change defaultmode for opensearch dashboards #342

allow adding plugins and change defaultmode for opensearch dashboards #342

BionIT commented Oct 27, 2022 •

edited

Loading

TheAlgo left a comment

BionIT commented Oct 28, 2022

peterzhuamazon commented Oct 28, 2022 •

edited

Loading

BionIT commented Oct 28, 2022

TheAlgo commented Oct 29, 2022

BionIT commented Oct 29, 2022

TheAlgo Nov 3, 2022

BionIT Nov 4, 2022

TheAlgo Nov 8, 2022

peterzhuamazon commented Nov 12, 2022

TheAlgo commented Nov 19, 2022

seanneumann commented Nov 23, 2022

prudhvigodithi Nov 23, 2022

BionIT Nov 25, 2022

prudhvigodithi commented Nov 23, 2022 •

edited

Loading

BionIT commented Nov 25, 2022

peterzhuamazon commented Nov 30, 2022

peterzhuamazon left a comment

peterzhuamazon commented Dec 7, 2022

peterzhuamazon commented Dec 7, 2022 •

edited

Loading

peterzhuamazon commented Dec 8, 2022

peterzhuamazon commented Dec 8, 2022

allow adding plugins and change defaultmode for opensearch dashboards #342

allow adding plugins and change defaultmode for opensearch dashboards #342

Conversation

BionIT commented Oct 27, 2022 • edited Loading

Description

Issues Resolved

Check List

TheAlgo left a comment

Choose a reason for hiding this comment

BionIT commented Oct 28, 2022

peterzhuamazon commented Oct 28, 2022 • edited Loading

BionIT commented Oct 28, 2022

TheAlgo commented Oct 29, 2022

BionIT commented Oct 29, 2022

TheAlgo Nov 3, 2022

Choose a reason for hiding this comment

BionIT Nov 4, 2022

Choose a reason for hiding this comment

TheAlgo Nov 8, 2022

Choose a reason for hiding this comment

peterzhuamazon commented Nov 12, 2022

TheAlgo commented Nov 19, 2022

seanneumann commented Nov 23, 2022

prudhvigodithi Nov 23, 2022

Choose a reason for hiding this comment

BionIT Nov 25, 2022

Choose a reason for hiding this comment

prudhvigodithi commented Nov 23, 2022 • edited Loading

BionIT commented Nov 25, 2022

peterzhuamazon commented Nov 30, 2022

peterzhuamazon left a comment

Choose a reason for hiding this comment

peterzhuamazon commented Dec 7, 2022

peterzhuamazon commented Dec 7, 2022 • edited Loading

peterzhuamazon commented Dec 8, 2022

peterzhuamazon commented Dec 8, 2022

BionIT commented Oct 27, 2022 •

edited

Loading

peterzhuamazon commented Oct 28, 2022 •

edited

Loading

prudhvigodithi commented Nov 23, 2022 •

edited

Loading

peterzhuamazon commented Dec 7, 2022 •

edited

Loading