search

opensearch-project / OpenSearch-Dashboards

📊 Open source visualization dashboards for OpenSearch.
https://opensearch.org/docs/latest/dashboards/index/
Apache License 2.0
1.65k stars 866 forks source link

Plugin artifacts should produce kebab-cased filenames that match plugin directory #366

Open trepersec opened 3 years ago

trepersec commented 3 years ago

Describe the bug

Following the documentation listed on https://docs-beta.opensearch.org/docs/opensearch-dashboards/install/plugins/ . I am installing the plugins but the links aren't being referenced properly and causing an error.

To Reproduce

  1. Go to https://docs-beta.opensearch.org/docs/opensearch-dashboards/install/plugins/
  2. Under the Install subcategory, copy and paste one of the commands to install a plugin e.g. /opt/opensearch/opensearch-dashboards/bin/opensearch-dashboards-plugin --allow-root install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-alerting/opensearchAlertingOpenSearch Dashboards-1.0.0.0.zip
  3. Error

Expected behavior

Correct resolution of the link to the plugin

OpenSearch Version

Installed via tar 1.0.0-beta1

Dashboards Version

Installed via tar

./opensearch-dashboards --allow-root --version
1.0.0-beta1

Plugins

./opensearch-dashboards-plugin list --allow-root
alertingDashboards@1.0.0.0-beta1
anomalyDetectionDashboards@1.0.0.0-beta1
ganttChartDashboards@1.0.0.0-beta1
indexManagementDashboards@1.0.0.0-beta1
notebooksDashboards@1.0.0.0-beta1
queryWorkbenchDashboards@1.0.0.0-beta1
reportsDashboards@1.0.0.0-beta1
traceAnalyticsDashboards@1.0.0.0-beta1

Screenshots

image

Host/Environment (please complete the following information):

Additional context

This applies to all of the other plugins as well

dblock commented 3 years ago

That file, "https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-alerting/opensearchAlertingOpenSearch Dashboards-1.0.0.0.zip" doesn't exist. I see two problems: 1) the file name has spaces and what not and should become kebab-case, 2) it wasn't published part of the beta

@VachaShah this is somewhat related to #357, could you please followup on 1), ie. plugins should be producing artifacts that match kebab case and not the plugin ID

trepersec commented 3 years ago

That file, "https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-alerting/opensearchAlertingOpenSearch Dashboards-1.0.0.0.zip" doesn't exist. I see two problems: 1) the file name has spaces and what not and should become kebab-case

I've tried different combinations of the link as I had the same assumptions, but none resolved:

Obviously, I could just not know the correct combination, but still wanted to relay the issue. Thank you!

dblock commented 3 years ago

@trepersec no, it doesn't exist in any form AFAIK, but I could be wrong: @bbarani what's the plan for these?

VachaShah commented 3 years ago

That file, "https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-alerting/opensearchAlertingOpenSearch Dashboards-1.0.0.0.zip" doesn't exist. I see two problems: 1) the file name has spaces and what not and should become kebab-case, 2) it wasn't published part of the beta

@VachaShah this is somewhat related to #357, could you please followup on 1), ie. plugins should be producing artifacts that match kebab case and not the plugin ID

This PR has been merged now.

dblock commented 3 years ago

I've assigned this one to you @VachaShah and renamed.