Plugins extend Elasticsearch’s core functionality and can be managed differently depending on the deployment type. While Elastic Cloud Enterprise (ECE) and Elastic Cloud Hosted (ECH) provide built-in plugin management, self-managed deployments require manual installation.

Elastic Cloud Enterprise and Elastic Cloud Hosted 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.

1. Log into the Cloud UI and selectCreate deployment.
2. Make your initial deployment selections, then selectCustomize Deployment.
3. Beneath the Elasticsearch master node, expand theManage plugins and settings caret.
4. Select the plugins you want.
5. SelectCreate deployment.

The deployment spins up with the plugins installed.

1. Log into the Cloud UI.

2. On theDeployments 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 theEdit page.

4. Beneath the Elasticsearch master node, expand theManage plugins and settings caret.

5. Select the plugins that you want.

6. SelectSave changes.

There is no downtime when adding plugins to highly available deployments. The deployment is updated with new nodes that have the plugins installed.

There are two ways to add plugins to Elastic Cloud Hosted deployments:

• Enable one of the official plugins already available in ECH
• Upload a custom plugin and then enable it per deployment.

Custom plugins can include the official Elasticsearch plugins not provided with ECH, any of the community-sourced plugins, orplugins that you write yourself. Uploading custom plugins is available only to Gold, Platinum, and Enterprise subscriptions. For more information, checkUpload custom plugins and bundles.

To learn more about the official and community-sourced plugins, refer toElasticsearch Plugins and Integrations.

For a detailed guide with examples of using the Elasticsearch Service API to create, get information about, update, and delete extensions and plugins, checkManaging plugins and extensions through the API.

You can use a variety of official plugins that are compatible with your version of Elasticsearch. When you upgrade to a new Elasticsearch version, these plugins are simply upgraded with the rest of your deployment.

Some restrictions apply when adding plugins. To learn more, checkRestrictions for Elasticsearch and Kibana plugins.

Only Gold, Platinum, Enterprise and Private subscriptions have access to uploading custom plugins. All subscription levels, including Standard, can upload scripts and dictionaries.

1. Log in to theElastic Cloud Console.

2. Find your deployment On the home page and selectManage next to it, or go to theDeployments page to view all deployments.

   On theDeployments 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 theActions dropdown, selectEdit deployment.

4. SelectManage user settings and extensions.

5. Select theExtensions tab.

6. Select the plugins that you want to enable.

7. SelectBack.

8. SelectSave. The Elasticsearch cluster is then updated with new nodes that have the plugin installed.

Use theelasticsearch-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, seePlugins directory

Run the following command to get usage instructions:

sudo bin/elasticsearch-plugin -h

For detailed instructions on installing, managing, and configuring plugins, see the following:

• Installing Plugins
• Custom URL or file system
• Installing multiple plugins
• Mandatory plugins
• Listing, removing and updating installed plugins
• Other command line parameters
• Manage plugins using a configuration file

If you run Elasticsearch using Docker, you can manage plugins using aconfiguration file.