Skip to content

Correct list of dashboards plugins #10264

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

Merged
merged 6 commits into from
Jul 21, 2025
Merged

Correct list of dashboards plugins #10264

merged 6 commits into from
Jul 21, 2025

Conversation

kolchfa-aws
Copy link
Collaborator

Closes #8582

Checklist

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

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@kolchfa-aws
Copy link
Collaborator Author

@peterzhuamazon Could you please review this PR?


Then remove all associated entries from `opensearch_dashboards.yml`.

For certain plugins, you must also remove the "optimize" bundle. This is a sample command for the Anomaly Detection plugin:
For certain plugins, you must also remove the optimized bundle. This is a sample command for the Anomaly Detection plugin:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
For certain plugins, you must also remove the optimized bundle. This is a sample command for the Anomaly Detection plugin:

Comment on lines 102 to 109

```bash
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
```
{% include copy.html %}

Then restart OpenSearch Dashboards. After you remove any plugin, OpenSearch Dashboards performs an optimize operation the next time you start it. This operation takes several minutes even on fast machines, so be patient.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```bash
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
```
{% include copy.html %}
Then restart OpenSearch Dashboards. After you remove any plugin, OpenSearch Dashboards performs an optimize operation the next time you start it. This operation takes several minutes even on fast machines, so be patient.

Comment on lines 119 to 125
{% include copy.html %}

1. Remove the optimized bundle:

```bash
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/<bundle-name>
```
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
{% include copy.html %}
1. Remove the optimized bundle:
```bash
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/<bundle-name>
```


```bash
sudo bin/opensearch-dashboards-plugin remove <plugin-name>
sudo bin/opensearch-dashboards-plugin remove alertingPlugin
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
sudo bin/opensearch-dashboards-plugin remove alertingPlugin
sudo bin/opensearch-dashboards-plugin remove alertingDashboards

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
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.

Only 1 issue if you can change alertingPlugin to alertingDashboards this PR is good.

Thanks.

@kolchfa-aws kolchfa-aws added Editorial review PR: Editorial review in progress and removed Awaiting response labels Jul 18, 2025
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

Editorial review

@natebower natebower removed the Editorial review PR: Editorial review in progress label Jul 21, 2025
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

@natebower
Copy link
Collaborator

@kolchfa-aws Can you fix Jekyll build failure?

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
@natebower natebower merged commit 54d1f76 into main Jul 21, 2025
6 checks passed
@natebower natebower deleted the plugin-names branch July 21, 2025 15:33
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 21, 2025
* Correct list of dashboards plugins

Signed-off-by: Fanit Kolchina <[email protected]>

* Review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Change plugin name

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Signed-off-by: Nathan Bower <[email protected]>

* Fix links

Signed-off-by: Fanit Kolchina <[email protected]>

* Fix link

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Nathan Bower <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 54d1f76)
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] wrong plugin names
3 participants