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

Update plugins.md with semver range support specification #6733

Merged
merged 17 commits into from
Mar 21, 2024
Merged
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions _install-and-configure/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"several bundled and additional plugins"?

abseth-amzn marked this conversation as resolved.
Show resolved Hide resolved

### 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 in one of the following notations:
abseth-amzn marked this conversation as resolved.
Show resolved Hide resolved
- `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 only specify one of `opensearch.version` or `dependencies` properties.
abseth-amzn marked this conversation as resolved.
Show resolved Hide resolved
{: .note}

### Bundled plugins

Expand Down
Loading