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

yarn opensearch arg to setup dependencies #2544

Closed
kavilla opened this issue Oct 10, 2022 · 3 comments · Fixed by #2734
Closed

yarn opensearch arg to setup dependencies #2544

kavilla opened this issue Oct 10, 2022 · 3 comments · Fixed by #2734
Assignees
Labels
enhancement New feature or request extensions PRs or issues specific to plugins as extensions v2.5.0 'Issues and PRs related to version v2.5.0'

Comments

@kavilla
Copy link
Member

kavilla commented Oct 10, 2022

Is your feature request related to a problem? Please describe.

As a developer working on an external plugin (for example the AD dashboards plugin) that requires a corresponding OpenSearch plugin, but I can not use the yarn opensearch command to start up the cluster because it will install a min of OpenSearch.

Therefore, I must either download a docker image, download a distribution, or pull down OpenSearch and clone my OpenSearch repo and build start. Even if I only want to do OpenSearch Dashboards development.

Describe the solution you'd like

I would like to run the yarn opensearch command to setup up a data source with an OpenSearch plugin that my OpenSearch Dashboards plugin requires.

For example, if I would like to start a snapshot of OpenSearch from OpenSearch Dashboards. I run yarn opensearch snapshot to get a min snapshot.

But I would like to do something like

yarn opensearch snapshot -P anomaly-detection
or
yarn opensearch snapshot -P file:{path}/anomaly-detection.zip
or
yarn opensearch snapshot -P {URL}/anomaly-detection.zip

Which will download the snapshot and install security plugin into the snapshot of OpenSearch. So that I can work completely in OpenSearch Dashboards. NOTE: P is just a suggestion not a final decision.

We can already configure the cluster config by passing -E [REF]. So adding more to this file that then executes opensearch-plugin with the value passed in.

Describe alternatives you've considered

Add a new config to the plugin manifest. That tells what data source requirement it needs and as a developer if I add this configuration then the start up OpenSearch installs those plugins if available.

Additional context

n/a

@kavilla kavilla added the enhancement New feature or request label Oct 10, 2022
@joshuarrrr
Copy link
Member

@kavilla Am I right in thinking this is mostly helpful in the case where a developer is just working on an OpenSearch Dashboard plugin? If they're working on both the OpenSearch Dashboard and OpenSearch plugin at the same time, they wouldn't be able to take advantage of the snapshot, right?

@manasvinibs
Copy link
Member

manasvinibs commented Oct 17, 2022

@joshuarrrr I think you're right! As part of the Extension installation process, we want to solve some of the problems for OpenSearch Dashboard plugin developers and this will be one of them.

@kavilla
Copy link
Member Author

kavilla commented Oct 17, 2022

@joshuarrr yes but using just using the CLI . Developers can download with knowing the snapshot link. The goal here though should be focusing on the OpenSearch Dashboards developer to only pull down OpenSearch Dashboards requirements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request extensions PRs or issues specific to plugins as extensions v2.5.0 'Issues and PRs related to version v2.5.0'
Projects
None yet
4 participants