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

Modified plugin documentation by clarifying valid plugin ID inputs #422

Merged
merged 2 commits into from
Feb 25, 2022
Merged
Changes from all 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
13 changes: 13 additions & 0 deletions _opensearch/install/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,22 @@ You can install individual plugins on an OpenSearch cluster.

## Install a plugin

The install command takes a plugin id, which may be any of the following:
keithhc2 marked this conversation as resolved.
Show resolved Hide resolved

- An official OpenSearch plugin name
- Maven coordinates to a plugin zip file
- A URL to a plugin zip file

If you're installing an official OpenSearch plugin, use:
```
bin/opensearch-plugin install <plugin-name>
```

For a plugin installed via zip, use:
```
bin/opensearch-plugin install <name|Zip File|Url>
```

Restart your OpenSearch node after installing a plugin.

## Remove a plugin
Expand Down