Update plugins.md with semver range support specification #6733
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add support for specifying 'dependencies' for a plugin in its plugin-descriptor.properties file. This property allows for specification of a range of OpenSearch versions for plugin compatibility check. Signed-off-by: abseth-amzn <[email protected]>
kolchfa-aws
requested review from
hdhalter,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
stephen-crawford
as code owners
hdhalter
added
4 - Doc review
|
Thanks for this submission, @abseth-amzn! Can you please address the errors? If you have any questions about anything, please let us know. |
kolchfa-aws
commented
Mar 20, 2024
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Thanks for the suggestions! I have accepted all of them. |
natebower
approved these changes
Mar 21, 2024
_install-and-configure/plugins.md
Outdated
| @@ -247,8 +247,23 @@ bin/opensearch-plugin install --batch <plugin-name> | |||
|
|
|||
| ## Available plugins | |||
|
|
|||
| Major, minor, and patch plugin versions must match OpenSearch major, minor, and patch versions in order to be compatible. For example, plugins versions 2.3.0.x work only with OpenSearch 2.3.0. | |||
| {: .warning} | |||
| OpenSearch provides several bundled plugins and additional plugins. | |||
There was a problem hiding this comment.
"several bundled and additional plugins"?
kolchfa-aws
commented
Mar 21, 2024
|
@abseth-amzn Please accept editorial suggestions, and we'll be ready to merge this PR. Thanks! |
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]>
|
I have accepted all the suggestions. |
CaptainDredge
pushed a commit
to CaptainDredge/documentation-website
that referenced
this pull request
Mar 22, 2024
…-project#6733) * Update plugins.md with semver range support specification Add support for specifying 'dependencies' for a plugin in its plugin-descriptor.properties file. This property allows for specification of a range of OpenSearch versions for plugin compatibility check. Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: abseth-amzn <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: abseth-amzn <[email protected]> --------- Signed-off-by: abseth-amzn <[email protected]> Co-authored-by: abseth-amzn <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
hdhalter
added
3 - Done
rursprung
reviewed
Apr 8, 2024
| ```properties | ||
| opensearch.version=2.3.0 | ||
| ``` | ||
| Alternatively, a plugin can specify a range of compatible OpenSearch versions by setting the `dependencies` property in its `plugin-descriptor.properties` file using one of the following notations: |
There was a problem hiding this comment.
shouldn't you specify that this is only available starting with 2.13.0? (all your examples currently use 2.3.0 where it wouldn't even work)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support for specifying 'dependencies' for a plugin in its plugin-descriptor.properties file. This property allows for specification of a range of OpenSearch versions for plugin compatibility check.
Description
Describe what this change achieves.
Issues Resolved
Closes #6433
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.