Rework plugins doc and add the mapper-size plugin #7646

cwperks · 2024-07-08T21:13:08Z

Description

While working on a separate issue in the security plugin, I noticed that the documentation website did not have documentation about the plugins that are built into opensearch-core. This PR adds a separate page about built-in plugins and adds a page specifically about the mapper-size plugin.

Version

all

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Craig Perkins <[email protected]>

hdhalter · 2024-07-08T21:21:19Z

Hey @cwperks - we already have these two sections with some cross-over: https://opensearch.org/docs/latest/install-and-configure/plugins/#bundled-plugins and https://opensearch.org/docs/latest/install-and-configure/plugins/#additional-plugins. Were you not able to find this?

cwperks · 2024-07-09T01:11:59Z

@hdhalter I found the section on additional plugins, but there isn't detailed information about each of the additional plugins. This PR takes the section on additional plugins and separates it into a new menu called "Built-in plugins" and then expands upon the mapper-size plugin to describe how to use it.

Signed-off-by: Craig Perkins <[email protected]>

hdhalter · 2024-07-10T16:19:43Z

@hdhalter I found the section on additional plugins, but there isn't detailed information about each of the additional plugins. This PR takes the section on additional plugins and separates it into a new menu called "Built-in plugins" and then expands upon the mapper-size plugin to describe how to use it.

Can we remove the existing sections and consolidate them?

hdhalter · 2024-07-17T00:37:01Z

Hi @cwperks , if you want to create a new topic for these plugins, we need to delete the table from this section, otherwise it will be redundant info.

I also think we need to differentiate between "bundled" plugins and "built-in" plugins, because they sound like the same thing. It says that the "built-in" plugins need to be installed on top of OpenSearch, so that implies that they are not built-in. How about we keep the topic "Installing plugins" (but actually give a procedure on how to do it), and have separate topics for "bundled" plugins and "custom" plugins?

The mapper-size plugin topic seems a bit out of place there, as we have other custom plugins that are described in our help. Thoughts?

Can you also check the version of documentation you are running against? Looks like 2.12.
Thanks!

Signed-off-by: Craig Perkins <[email protected]>

cwperks · 2024-07-24T19:51:15Z

@hdhalter I pushed a PR to remove the table and link directly to a page on Additional plugins where Built-in plugins are a subsection. I was thinking that additional plugins could be split into 2 categories: built-in plugins that are included with OpenSearch vs. community plugins where a zip file is needed for installation.

These built-in plugins are applicable to all versions of opensearch. Query insights is an exception, but that has since been removed from core and is now similar to other plugins included in the default distribution.

cwperks · 2024-07-24T19:51:37Z

Can you also check the version of documentation you are running against? Looks like 2.12.

This is applicable to all versions of OpenSearch

Signed-off-by: Craig Perkins <[email protected]>

Signed-off-by: Heather Halter <[email protected]>

cwperks · 2024-07-26T19:39:26Z

@hdhalter Thanks for pushing changes to this PR! The changes LGTM 🚢

Naarcha-AWS

LGTM. However, would it make sense to make a single "Plugins" section with the following architecture:

Plugins (Index page)
- Installing plugins
- Additional plugins

_install-and-configure/additional-plugins/index.md

_install-and-configure/plugins.md

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]>

hdhalter · 2024-07-26T22:59:39Z

@Naarcha-AWS - Since the section is currently under "Installation and Upgrade", I think it makes sense to keep the topic "Installing plugins" (task-based) as the first topic users see. The two other topics are more for reference. But let me know if you have a different idea.

natebower

@cwperks Please see my comments and changes and let me know if you have any questions. Thanks!

_install-and-configure/additional-plugins/index.md

_install-and-configure/additional-plugins/mapper-size-plugin.md

_install-and-configure/plugins.md

natebower · 2024-07-29T11:44:04Z

_install-and-configure/plugins.md

+
+## 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:


Can the plugin do this, or does the user do this? If the latter, please rephrase accordingly.

Plugin developers specify compatibility.

@cwperks I like it!

natebower · 2024-07-29T11:45:04Z

_install-and-configure/plugins.md

+```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:


Can the plugin do this, or does the user do this? If the latter, please rephrase accordingly.

_install-and-configure/plugins.md

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

hdhalter

Thanks for the review, @natebower! @cwperks - can you please confirm my updates?

_install-and-configure/plugins.md

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]>

* Add documentation about the mapper-size plugin Signed-off-by: Craig Perkins <[email protected]> * Fix link checker Signed-off-by: Craig Perkins <[email protected]> * Apply feedback Signed-off-by: Craig Perkins <[email protected]> * Fix links Signed-off-by: Craig Perkins <[email protected]> * Respond to feedback Signed-off-by: Craig Perkins <[email protected]> * fix-nav-pane Signed-off-by: Heather Halter <[email protected]> * fixed-parent Signed-off-by: Heather Halter <[email protected]> * additional-formatting-changes Signed-off-by: Heather Halter <[email protected]> * moretweaks Signed-off-by: Heather Halter <[email protected]> * more tweaks Signed-off-by: Heather Halter <[email protected]> * reworded the intros and added collapsible blocks Signed-off-by: Heather Halter <[email protected]> * small tweak Signed-off-by: Heather Halter <[email protected]> * more tweaks to wording Signed-off-by: Heather Halter <[email protected]> * Update installation message text Signed-off-by: Craig Perkins <[email protected]> * Update _install-and-configure/additional-plugins/index.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]> * Mention more core functionality Signed-off-by: Craig Perkins <[email protected]> * final changes Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/index.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/mapper-size-plugin.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/mapper-size-plugin.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]> --------- Signed-off-by: Craig Perkins <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit e7b36f7) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…#7646) * Add documentation about the mapper-size plugin Signed-off-by: Craig Perkins <[email protected]> * Fix link checker Signed-off-by: Craig Perkins <[email protected]> * Apply feedback Signed-off-by: Craig Perkins <[email protected]> * Fix links Signed-off-by: Craig Perkins <[email protected]> * Respond to feedback Signed-off-by: Craig Perkins <[email protected]> * fix-nav-pane Signed-off-by: Heather Halter <[email protected]> * fixed-parent Signed-off-by: Heather Halter <[email protected]> * additional-formatting-changes Signed-off-by: Heather Halter <[email protected]> * moretweaks Signed-off-by: Heather Halter <[email protected]> * more tweaks Signed-off-by: Heather Halter <[email protected]> * reworded the intros and added collapsible blocks Signed-off-by: Heather Halter <[email protected]> * small tweak Signed-off-by: Heather Halter <[email protected]> * more tweaks to wording Signed-off-by: Heather Halter <[email protected]> * Update installation message text Signed-off-by: Craig Perkins <[email protected]> * Update _install-and-configure/additional-plugins/index.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]> * Mention more core functionality Signed-off-by: Craig Perkins <[email protected]> * final changes Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/index.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/mapper-size-plugin.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/additional-plugins/mapper-size-plugin.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]> * Update _install-and-configure/plugins.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]> --------- Signed-off-by: Craig Perkins <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

Add documentation about the mapper-size plugin

6d20099

Signed-off-by: Craig Perkins <[email protected]>

cwperks requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners July 8, 2024 21:13

Fix link checker

c2b024c

Signed-off-by: Craig Perkins <[email protected]>

hdhalter assigned Naarcha-AWS Jul 10, 2024

hdhalter added the 4 - Doc review PR: Doc review in progress label Jul 10, 2024

hdhalter assigned hdhalter and unassigned Naarcha-AWS Jul 18, 2024

hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. backport 2.15 and removed 4 - Doc review PR: Doc review in progress labels Jul 18, 2024

Apply feedback

2a0a761

Signed-off-by: Craig Perkins <[email protected]>

cwperks and others added 5 commits July 24, 2024 15:55

Merge branch 'main' into mapper-size

dc5fa89

Fix links

79e48f0

Signed-off-by: Craig Perkins <[email protected]>

Respond to feedback

5a97f26

Signed-off-by: Craig Perkins <[email protected]>

fix-nav-pane

c76959a

Signed-off-by: Heather Halter <[email protected]>

fixed-parent

8e780df

Signed-off-by: Heather Halter <[email protected]>

hdhalter added the 3 - Tech review PR: Tech review in progress label Jul 26, 2024

hdhalter added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Jul 26, 2024

Naarcha-AWS approved these changes Jul 26, 2024

View reviewed changes

_install-and-configure/additional-plugins/index.md Outdated Show resolved Hide resolved

_install-and-configure/plugins.md Outdated Show resolved Hide resolved

hdhalter and others added 2 commits July 26, 2024 15:47

Update _install-and-configure/plugins.md

b58060f

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Update _install-and-configure/additional-plugins/index.md

35ad9b9

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]>

hdhalter added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jul 26, 2024

natebower reviewed Jul 29, 2024

View reviewed changes

hdhalter and others added 9 commits July 29, 2024 08:28

Update _install-and-configure/additional-plugins/index.md

4a15960

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Update _install-and-configure/additional-plugins/index.md

8ee1167

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Update _install-and-configure/additional-plugins/mapper-size-plugin.md

f9f2c10

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Update _install-and-configure/additional-plugins/mapper-size-plugin.md

b6ef19f

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Update _install-and-configure/plugins.md

81f903d

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Update _install-and-configure/plugins.md

78d2ee6

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Update _install-and-configure/plugins.md

c47107e

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Update _install-and-configure/plugins.md

4c3815a

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

Apply suggestions from code review

a1029d2

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]>

hdhalter reviewed Jul 29, 2024

View reviewed changes

_install-and-configure/plugins.md Outdated Show resolved Hide resolved

_install-and-configure/plugins.md Outdated Show resolved Hide resolved

cwperks and others added 2 commits July 29, 2024 12:06

Update _install-and-configure/plugins.md

64e6a2b

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]>

Update _install-and-configure/plugins.md

8612e21

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Craig Perkins <[email protected]>

hdhalter added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Jul 29, 2024

hdhalter merged commit e7b36f7 into opensearch-project:main Jul 29, 2024
8 checks passed

opensearch-trigger-bot bot mentioned this pull request Jul 29, 2024

[Backport 2.15] Rework plugins doc and add the mapper-size plugin #7854

Merged

github-actions bot pushed a commit that referenced this pull request Jul 29, 2024

Rework plugins doc and add the mapper-size plugin (#7646) (#7854)

af31ea3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework plugins doc and add the mapper-size plugin #7646

Rework plugins doc and add the mapper-size plugin #7646

cwperks commented Jul 8, 2024

hdhalter commented Jul 8, 2024

cwperks commented Jul 9, 2024 •

edited

Loading

hdhalter commented Jul 10, 2024

hdhalter commented Jul 17, 2024

cwperks commented Jul 24, 2024

cwperks commented Jul 24, 2024

cwperks commented Jul 26, 2024

Naarcha-AWS left a comment

hdhalter commented Jul 26, 2024

natebower left a comment

natebower Jul 29, 2024

cwperks Jul 29, 2024

natebower Jul 29, 2024

natebower Jul 29, 2024

hdhalter left a comment


		## 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:

Rework plugins doc and add the mapper-size plugin #7646

Rework plugins doc and add the mapper-size plugin #7646

Conversation

cwperks commented Jul 8, 2024

Description

Version

Checklist

hdhalter commented Jul 8, 2024

cwperks commented Jul 9, 2024 • edited Loading

hdhalter commented Jul 10, 2024

hdhalter commented Jul 17, 2024

cwperks commented Jul 24, 2024

cwperks commented Jul 24, 2024

cwperks commented Jul 26, 2024

Naarcha-AWS left a comment

Choose a reason for hiding this comment

hdhalter commented Jul 26, 2024

natebower left a comment

Choose a reason for hiding this comment

natebower Jul 29, 2024

Choose a reason for hiding this comment

cwperks Jul 29, 2024

Choose a reason for hiding this comment

natebower Jul 29, 2024

Choose a reason for hiding this comment

natebower Jul 29, 2024

Choose a reason for hiding this comment

hdhalter left a comment

Choose a reason for hiding this comment

cwperks commented Jul 9, 2024 •

edited

Loading