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

[Decouple] OSD plugin manifest to define semver compatible OS plugin #4611

Closed
manasvinibs opened this issue Jul 24, 2023 · 1 comment
Closed
Assignees

Comments

@manasvinibs
Copy link
Member

Description

Extending the functionality here:
#3116

OSD plugins will have require OS counterparts for them to function correctly. Add the ability to let the OSD plugin define in their opensearch_dashboards.json plugin manifest to not only define required OS plugins but also the version their OSD plugin supports for OS.

For example,

if I have an alerting dashboards plugin 2.9.0, I can define in my plugin manifest

{
  ...,
  "requiredOpenSearchPlugins": ["alerting"],
  "compatibleOpenSearchPluginsVersions": [
    {
      "id": "alerting",
      "version":  "^2.0.0",
    }
  ],
  ...,
}

^ Not the requirement to be exactly that.

Requirements:

  • Design proposal
    • Do we want to restructure the existing requiredOpenSearchPlugins as it is relatively new (2.9) and seemingly unused to just be a map or array of objects?
    • Name of the new config
    • The versioning format
      • should it be semver/NPM like formatted?
      • should it be a range?
    • Does it also support the "OS" core version [ISSUE]
    • What happens on runtime / before runtime?
      • Does it fail to start?
      • Does it start but disable the plugin in OSD?
  • Implement changes
  • For initial implementation the expectation will be a 1-1 match from OSD plugin to OSD. The goal here is to have 1-many relationship with OSD plugin to OS.
  • Testing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant