github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 17:34:17 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Plugin management reference cleanup (#124578)

Browse source 
* add content to plugin management

* add content to Plugin Management

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

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>

* fix applies-to tag

* add ech to docset.yml

---------

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
This commit is contained in:
Charlotte Hoblik 2025-03-12 17:01:10 +01:00 • committed by GitHub
parent 44fba7213d
commit 9e754ec8f6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 163 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/reference/elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md
View file

@ -1,30 +0,0 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-adding-elastic-plugins.html
---
# Add plugins provided with Elasticsearch Service [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, running version 2.4.6 or later, have access to uploading custom plugins. All subscription levels, including Standard, can upload scripts and dictionaries.
To enable a plugin for a deployment:
1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body).
2. Find your deployment on the home page in the Elasticsearch Service card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your 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.

31
docs/reference/elasticsearch-plugins/cloud/ec-adding-plugins.md
View file

@ -1,31 +0,0 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-adding-plugins.html
---
# Add plugins and extensions [ec-adding-plugins]
Plugins extend the core functionality of {{es}}. There are many suitable plugins, including:
* 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.
Plugins can come from different sources: the official ones created or at least maintained by Elastic, community-sourced plugins from other users, and plugins that you provide. Some of the official plugins are always provided with our service, and can be [enabled per deployment](/reference/elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md\).
There are two ways to add plugins to a deployment in Elasticsearch Service:
* [Enable one of the official plugins already available in Elasticsearch Service](/reference/elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md\).
* [Upload a custom plugin and then enable it per deployment](/reference/elasticsearch-plugins/cloud/ec-custom-bundles.md\).
Custom plugins can include the official {{es}} plugins not provided with Elasticsearch Service, 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](/reference/elasticsearch-plugins/cloud/ec-custom-bundles.md\).
To learn more about the official and community-sourced plugins, refer to [{{es}} Plugins and Integrations](/reference/elasticsearch-plugins/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](/reference/elasticsearch-plugins/cloud/ec-plugins-guide.md\).
Plugins are not supported for {{kib}}. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](cloud://release-notes/cloud-hosted/known-issues.md#ec-restrictions-plugins).

3
docs/reference/elasticsearch-plugins/cloud/ec-custom-bundles.md
View file

@ -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]

5
docs/reference/elasticsearch-plugins/cloud/ec-plugins-guide.md
View file

@ -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)