[DOCS] Plugin management reference cleanup (elastic#124578)

charlotte-hoblik · florent-leborgne · albertzaharovits · commit 55e7caa5acab · 2025-03-13T13:50:18.000+02:00
* add content to plugin management

* add content to Plugin Management

* Update docs/reference/elasticsearch-plugins/plugin-management.md

Co-authored-by: florent-leborgne &lt;florent.leborgne@elastic.co&gt;

* fix applies-to tag

* add ech to docset.yml

---------

Co-authored-by: florent-leborgne &lt;florent.leborgne@elastic.co&gt;
diff --git a/docs/docset.yml b/docs/docset.yml
@@ -168,6 +168,7 @@ subs:
   ess:   "Elasticsearch Service"
   ece:   "Elastic Cloud Enterprise"
   eck:   "Elastic Cloud on Kubernetes"
+  ech:   "Elastic Cloud Hosted"
   serverless-full:   "Elastic Cloud Serverless"
   serverless-short:   "Serverless"
   es-serverless:   "Elasticsearch Serverless"
diff --git a/docs/reference/elasticsearch-plugins/_other_command_line_parameters.md b/docs/reference/elasticsearch-plugins/_other_command_line_parameters.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/_other_command_line_parameters.html
+applies_to:
+  deployment:
+    self: ga
 ---
 
 # Other command line parameters [_other_command_line_parameters]
diff --git a/docs/reference/elasticsearch-plugins/_plugins_directory.md b/docs/reference/elasticsearch-plugins/_plugins_directory.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/_plugins_directory.html
+applies_to:
+  deployment:
+    self: ga
 ---
 
 # Plugins directory [_plugins_directory]
diff --git a/docs/reference/elasticsearch-plugins/cloud-enterprise/ece-add-plugins.md b/docs/reference/elasticsearch-plugins/cloud-enterprise/ece-add-plugins.md
diff --git a/docs/reference/elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md b/docs/reference/elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md
diff --git a/docs/reference/elasticsearch-plugins/cloud/ec-adding-plugins.md b/docs/reference/elasticsearch-plugins/cloud/ec-adding-plugins.md
diff --git a/docs/reference/elasticsearch-plugins/cloud/ec-custom-bundles.md b/docs/reference/elasticsearch-plugins/cloud/ec-custom-bundles.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/cloud/current/ec-custom-bundles.html
+applies_to:
+  deployment:
+    ess: ga
 ---
 
 # Upload custom plugins and bundles [ec-custom-bundles]
diff --git a/docs/reference/elasticsearch-plugins/cloud/ec-plugins-guide.md b/docs/reference/elasticsearch-plugins/cloud/ec-plugins-guide.md
@@ -1,11 +1,14 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/cloud/current/ec-plugins-guide.html
+applies_to:
+  deployment:
+    ess: ga
 ---
 
 # Managing plugins and extensions through the API [ec-plugins-guide]
 
-This guide provides a full list of tasks for managing [plugins and extensions](ec-adding-plugins.md) in Elasticsearch Service, using the API.
+This guide provides a full list of tasks for managing [plugins and extensions](../plugin-management.md) in Elasticsearch Service, using the API.
 
 * [Create an extension](ec-plugins-guide.md#ec-extension-guide-create)
 * [Add an extension to a deployment plan](ec-plugins-guide.md#ec-extension-guide-add-plan)
diff --git a/docs/reference/elasticsearch-plugins/installation.md b/docs/reference/elasticsearch-plugins/installation.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/installation.html
+applies_to:
+  deployment:
+    self: ga
 ---
 
 # Installing plugins [installation]
diff --git a/docs/reference/elasticsearch-plugins/installing-multiple-plugins.md b/docs/reference/elasticsearch-plugins/installing-multiple-plugins.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/installing-multiple-plugins.html
+applies_to:
+  deployment:
+    self: ga
 ---
 
 # Installing multiple plugins [installing-multiple-plugins]
diff --git a/docs/reference/elasticsearch-plugins/listing-removing-updating.md b/docs/reference/elasticsearch-plugins/listing-removing-updating.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/listing-removing-updating.html
+applies_to:
+  deployment:
+    self: ga
 ---
 
 # Listing, removing and updating installed plugins [listing-removing-updating]
diff --git a/docs/reference/elasticsearch-plugins/manage-plugins-using-configuration-file.md b/docs/reference/elasticsearch-plugins/manage-plugins-using-configuration-file.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/manage-plugins-using-configuration-file.html
+applies_to:
+  deployment:
+    self: ga
 ---
 
 # Manage plugins using a configuration file [manage-plugins-using-configuration-file]
diff --git a/docs/reference/elasticsearch-plugins/mandatory-plugins.md b/docs/reference/elasticsearch-plugins/mandatory-plugins.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/mandatory-plugins.html
+applies_to:
+  deployment:
+    self: ga
 ---
 
 # Mandatory plugins [mandatory-plugins]
diff --git a/docs/reference/elasticsearch-plugins/plugin-management-custom-url.md b/docs/reference/elasticsearch-plugins/plugin-management-custom-url.md
@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugin-management-custom-url.html
+applies_to:
+  deployment:
+    self: ga
 ---
 
 # Custom URL or file system [plugin-management-custom-url]
diff --git a/docs/reference/elasticsearch-plugins/plugin-management.md b/docs/reference/elasticsearch-plugins/plugin-management.md
@@ -2,10 +2,135 @@
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugin-management.html
   - https://www.elastic.co/guide/en/cloud/current/ec-adding-plugins.html
+  - https://www.elastic.co/guide/en/cloud/current/ec-adding-elastic-plugins.html
   - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-plugins.html
+applies_to:
+  deployment:
+    ess: ga
+    ece: ga
+    self: ga
+  serverless: unavailable
 ---
 
 # Plugin management
 
-% The inventory is not clear about which of the mapped pages should be source material
-% for this page vs. added as separate pages.
+Plugins extend Elasticsearch’s core functionality and can be managed differently depending on the deployment type. While {{ece}} (ECE) and {{ech}} (ECH) provide built-in plugin management, self-managed deployments require manual installation.
+
+{{ece}} and {{ech}} deployments simplify plugin management by offering compatible plugins for your Elasticsearch version. These plugins are automatically upgraded with your deployment, except in cases of breaking changes.
+
+In ECE and ECH deployments, you can add plugins by selecting them from the available list. However, plugin availability depends on the Elasticsearch version.
+
+Plugins serve various purposes, including:
+
+* National language support, phonetic analysis, and extended unicode support
+* Ingesting attachments in common formats and ingesting information about the geographic location of IP addresses
+* Adding new field datatypes to Elasticsearch
+* Discovery plugins, such as the cloud AWS plugin that allows discovering nodes on EC2 instances.
+* Analysis plugins, to provide analyzers targeted at languages other than English.
+* Scripting plugins, to provide additional scripting languages.
+
+## Managing plugins for ECE
+```{applies_to}
+    ece: ga
+```
+
+### Add plugins when creating a new ECE deployment
+
+1. [Log into the Cloud UI](docs-content://deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md) and select **Create deployment**.
+2. Make your initial deployment selections, then select **Customize Deployment**.
+3. Beneath the Elasticsearch master node, expand the **Manage plugins and settings** caret.
+4. Select the plugins you want.
+5. Select **Create deployment**.
+
+The deployment spins up with the plugins installed.
+
+### Add plugins to an existing ECE deployment
+
+1. [Log into the Cloud UI](docs-content://deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
+2. On the **Deployments** page, select your deployment.
+
+    Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
+
+3. From your deployment menu, go to the **Edit** page.
+4. Beneath the Elasticsearch master node, expand the **Manage plugins and settings** caret.
+5. Select the plugins that you want.
+6. Select **Save changes**.
+
+There is no downtime when adding plugins to highly available deployments. The deployment is updated with new nodes that have the plugins installed.
+
+## Managing plugins for ECH
+```{applies_to}
+    ess: ga
+```
+
+There are two ways to add plugins to {{ech}} deployments:
+
+* Enable one of the official plugins already available in ECH
+* [Upload a custom plugin and then enable it per deployment](./cloud/ec-custom-bundles.md).
+
+Custom plugins can include the official {{es}} plugins not provided with ECH, any of the community-sourced plugins, or [plugins that you write yourself](/extend/index.md). Uploading custom plugins is available only to Gold, Platinum, and Enterprise subscriptions. For more information, check [Upload custom plugins and bundles](./cloud/ec-custom-bundles.md).
+
+To learn more about the official and community-sourced plugins, refer to [{{es}} Plugins and Integrations](index.md).
+
+For a detailed guide with examples of using the Elasticsearch Service API to create, get information about, update, and delete extensions and plugins, check [Managing plugins and extensions through the API](./cloud/ec-plugins-guide.md).
+
+### Add plugins provided with ECH [ec-adding-elastic-plugins]
+
+You can use a variety of official plugins that are compatible with your version of {{es}}. When you upgrade to a new {{es}} version, these plugins are simply upgraded with the rest of your deployment.
+
+#### Before you begin [ec_before_you_begin_6]
+
+Some restrictions apply when adding plugins. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](cloud://release-notes/cloud-hosted/known-issues.md#ec-restrictions-plugins).
+
+Only Gold, Platinum, Enterprise and Private subscriptions have access to uploading custom plugins. All subscription levels, including Standard, can upload scripts and dictionaries.
+
+### Enabling plugins for a deployment
+
+1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
+2. Find your deployment On the home page and select **Manage** next to it, or go to the **Deployments** page to view all deployments.
+
+    On the **Deployments** page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
+
+3. From the **Actions** dropdown, select **Edit deployment**.
+4. Select **Manage user settings and extensions**.
+5. Select the **Extensions** tab.
+6. Select the plugins that you want to enable.
+7. Select **Back**.
+8. Select **Save**. The {{es}} cluster is then updated with new nodes that have the plugin installed.
+
+## Managing plugins for self-managed deployments
+```{applies_to}
+    self: ga
+```
+Use the `elasticsearch-plugin` command line tool to install, list, and remove plugins. It is located in the `$ES_HOME/bin` directory by default but it may be in a different location depending on which Elasticsearch package you installed. For more information, see [Plugins directory](_plugins_directory.md)
+
+Run the following command to get usage instructions:
+
+``` 
+sudo bin/elasticsearch-plugin -h
+```
+
+:::{important} Running as root
+If Elasticsearch was installed using the deb or rpm package then run `/usr/share/elasticsearch/bin/elasticsearch-plugin` as `root` so it can write to the appropriate files on disk. Otherwise run `bin/elasticsearch-plugin` as the user that owns all of the Elasticsearch files.
+:::
+
+For detailed instructions on installing, managing, and configuring plugins, see the following:
+
+* [Intalling Plugings](./installation.md)
+* [Custom URL or file system](./plugin-management-custom-url.md)
+* [Installing multiple plugins](./installing-multiple-plugins.md)
+* [Mandatory plugins](./mandatory-plugins.md)
+* [Listing, removing and updating installed plugins](./listing-removing-updating.md)
+* [Other command line parameters](./_other_command_line_parameters.md)
+* [Manage plugins using a configuration file](./manage-plugins-using-configuration-file.md)
+
+## Managing plugins for docker deployments
+```{applies_to}
+    self: ga
+```
+If you run Elasticsearch using Docker, you can manage plugins using a [configuration file](manage-plugins-using-configuration-file.md).
+
+
+
+
+
diff --git a/docs/reference/elasticsearch-plugins/toc.yml b/docs/reference/elasticsearch-plugins/toc.yml
@@ -10,12 +10,8 @@ toc:
       - file: _other_command_line_parameters.md
       - file: _plugins_directory.md
       - file: manage-plugins-using-configuration-file.md
-      - file: cloud/ec-adding-plugins.md
-        children:
-          - file: cloud/ec-adding-elastic-plugins.md
-          - file: cloud/ec-custom-bundles.md
-          - file: cloud/ec-plugins-guide.md
-      - file: cloud-enterprise/ece-add-plugins.md
+      - file: cloud/ec-custom-bundles.md
+      - file: cloud/ec-plugins-guide.md
   - file: api-extension-plugins.md
   - file: analysis-plugins.md
     children:
diff --git a/docs/reference/toc.yml b/docs/reference/toc.yml
@@ -319,12 +319,8 @@ toc:
           - file: elasticsearch-plugins/_other_command_line_parameters.md
           - file: elasticsearch-plugins/_plugins_directory.md
           - file: elasticsearch-plugins/manage-plugins-using-configuration-file.md
-          - file: elasticsearch-plugins/cloud/ec-adding-plugins.md
-            children:
-              - file: elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md
-              - file: elasticsearch-plugins/cloud/ec-custom-bundles.md
-              - file: elasticsearch-plugins/cloud/ec-plugins-guide.md
-          - file: elasticsearch-plugins/cloud-enterprise/ece-add-plugins.md
+          - file: elasticsearch-plugins/cloud/ec-custom-bundles.md
+          - file: elasticsearch-plugins/cloud/ec-plugins-guide.md
       - file: elasticsearch-plugins/api-extension-plugins.md
       - file: elasticsearch-plugins/analysis-plugins.md
         children:
