Update plugins.md with semver range support specification (#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]>
opensearch-project · Mar 21, 2024 · d261cf1 · d261cf1
1 parent 1fb9066
commit d261cf1
Showing 1 changed file with 17 additions and 2 deletions.
diff --git a/_install-and-configure/plugins.md b/_install-and-configure/plugins.md
@@ -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 and additional plugins.
+
+### Plugin compatibility
+
+A plugin can explicitly specify compatibility with a specific OpenSearch version by listing that version in its `plugin-descriptor.properties` file. For example, a plugin with the following property is compatible only with OpenSearch 2.3.0:
+
+```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:
+- `dependencies={ opensearch: "2.3.0" }`: The plugin is compatible only with OpenSearch version 2.3.0.
+- `dependencies={ opensearch: "=2.3.0" }`: The plugin is compatible only with OpenSearch version 2.3.0.
+- `dependencies={ opensearch: "~2.3.0" }`: The plugin is compatible with all versions starting from 2.3.0 up to the next minor version, in this example, 2.4.0 (exclusive).
+- `dependencies={ opensearch: "^2.3.0" }`: The plugin is compatible with all versions starting from 2.3.0 up to the next major version, in this example, 3.0.0 (exclusive).
+
+You can specify only one of the `opensearch.version` or `dependencies` properties.
+{: .note}
 
 ### Bundled plugins