diff --git a/deploy-manage/deploy/cloud-enterprise/add-plugins.md b/deploy-manage/deploy/cloud-enterprise/add-plugins.md index 2c5e400913..2cb52eaa7d 100644 --- a/deploy-manage/deploy/cloud-enterprise/add-plugins.md +++ b/deploy-manage/deploy/cloud-enterprise/add-plugins.md @@ -1,5 +1,7 @@ --- navigation_title: Add plugins and extensions +mapped_pages: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-plugins.html applies_to: deployment: ece: @@ -26,7 +28,7 @@ Additional plugins might be available. If a plugin is listed for your version of You can also [create](elasticsearch://extend/index.md) and add custom plugins. -To add plugins when creating a new deployment: +## Add plugins when creating a new {{ece}} deployment 1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md) and select **Create deployment**. 2. Make your initial deployment selections, then select **Advanced settings**. @@ -36,7 +38,7 @@ To add plugins when creating a new deployment: The deployment spins up with the plugins installed. -To add plugins to an existing deployment: +## Add plugins to an existing {{ece}} deployment 1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). 2. On the **Deployments** page, select your deployment. diff --git a/deploy-manage/deploy/elastic-cloud/_snippets/enable-extensions-on-deployment.md b/deploy-manage/deploy/elastic-cloud/_snippets/enable-extensions-on-deployment.md new file mode 100644 index 0000000000..4883200732 --- /dev/null +++ b/deploy-manage/deploy/elastic-cloud/_snippets/enable-extensions-on-deployment.md @@ -0,0 +1,11 @@ +1. Log in to [{{ecloud}}](https://cloud.elastic.co?page=docs&placement=docs-body). +2. Find your deployment on the home page or on the **Hosted deployments** page, then select **Manage** to access its settings menus. + + On the **Hosted 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 or extensions 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. diff --git a/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md b/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md index 66947e6bb3..da7ad41529 100644 --- a/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md +++ b/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md @@ -4,6 +4,7 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-heroku/current/ech-adding-plugins.html - https://www.elastic.co/guide/en/cloud-heroku/current/ech-adding-elastic-plugins.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 applies_to: deployment: ess: ga @@ -13,27 +14,38 @@ products: # Add plugins and extensions in {{ech}} [ec-adding-plugins] -Plugins extend the core functionality of {{es}}. There are many suitable plugins, including: +Plugins extend the core functionality of {{es}}. {{ech}} simplifies plugin management by offering compatible plugins for your {{es}} version. These plugins are automatically upgraded with your deployment, except when there are breaking changes. + +In {{ech}} deployments, you can add plugins by selecting them from the available list. Plugin availability depends on your {{es}} version. + +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](elasticsearch://reference/elasticsearch-plugins/plugin-management.md). - -There are two ways to add plugins to a hosted deployment in {{ecloud}}: +Plugins can come from different sources: official ones created or 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](#ec-adding-elastic-plugins). -* [Enable one of the official plugins already available in {{ecloud}}](elasticsearch://reference/elasticsearch-plugins/plugin-management.md). -* [Upload a custom plugin and then enable it per deployment](upload-custom-plugins-bundles.md). +To add plugins to a hosted deployment in {{ecloud}}, you can: -Custom plugins can include the official {{es}} plugins not provided with {{ecloud}}, any of the community-sourced plugins, or [plugins that you write yourself](elasticsearch://extend/index.md). Uploading custom plugins is available only to Gold, Platinum, and Enterprise subscriptions. For more information, check [Upload custom plugins and bundles](upload-custom-plugins-bundles.md). +* [Enable one of the official plugins already available in {{ecloud}}](#ec-adding-elastic-plugins). To learn more about the official and community-sourced plugins, refer to [{{es}} plugins](elasticsearch://reference/elasticsearch-plugins/index.md). +* [Upload a custom plugin and then enable it per deployment](upload-custom-plugins-bundles.md). Custom plugins can include the official {{es}} plugins not provided with {{ecloud}}, any of the community-sourced plugins, or [plugins that you write yourself](elasticsearch://extend/index.md). -To learn more about the official and community-sourced plugins, refer to [{{es}} Plugins and Integrations](elasticsearch://reference/elasticsearch-plugins/index.md). For a detailed guide with examples of using the {{ecloud}} API to create, get information about, update, and delete extensions and plugins, check [Managing plugins and extensions through the API](manage-plugins-extensions-through-api.md). -Plugins are not supported for {{kib}}. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](restrictions-known-problems.md#ec-restrictions-plugins). +## 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 upgraded with the rest of your deployment. + +### Before you begin [ec_before_you_begin_6] + +Some restrictions apply when adding plugins. For example, plugins are not supported for {{kib}}. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](restrictions-known-problems.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. +### Enable plugins for a deployment +:::{include} _snippets/enable-extensions-on-deployment.md +::: diff --git a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md index 7381c59b80..d5909351c8 100644 --- a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md +++ b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md @@ -136,17 +136,8 @@ Refer to [Managing plugins and extensions through the API](../../../deploy-manag After uploading your files, you can select to enable them when creating a new {{es}} deployment. For existing deployments, you must update your deployment configuration to use the new files: -1. Log in to [{{ecloud}}](https://cloud.elastic.co?page=docs&placement=docs-body). -2. Find your deployment on the home page or on the **Hosted deployments** page, then select **Manage** to access its settings menus. - - On the **Hosted 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 custom extension. -7. Select **Back**. -8. Select **Save**. The {{es}} cluster is then updated with new nodes that have the plugin installed. +:::{include} _snippets/enable-extensions-on-deployment.md +::: ## Update your extension [ec-update-bundles-and-plugins] diff --git a/deploy-manage/users-roles/cluster-or-deployment-auth/kerberos.md b/deploy-manage/users-roles/cluster-or-deployment-auth/kerberos.md index 7c887347ad..d0a7066467 100644 --- a/deploy-manage/users-roles/cluster-or-deployment-auth/kerberos.md +++ b/deploy-manage/users-roles/cluster-or-deployment-auth/kerberos.md @@ -166,7 +166,7 @@ For detailed information of available realm settings, see [Kerberos realm settin ::::{applies-item} { ess:, ece: } -1. Create a [custom bundle](elasticsearch://reference/elasticsearch-plugins/plugin-management.md) that contains your `krb5.conf` and `keytab` files, and add it to your cluster. +1. Add a custom bundle that contains your `krb5.conf` and `keytab` files to your cluster. For {{ech}}, follow [Upload custom plugins and bundles](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). For {{ece}}, follow [Add custom bundles and plugins](/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md). :::{tip} You should use these exact filenames for {{ecloud}} to recognize the file in the bundle. diff --git a/explore-analyze/machine-learning/nlp/ml-nlp-inference.md b/explore-analyze/machine-learning/nlp/ml-nlp-inference.md index c8ca809307..cc91d4d186 100644 --- a/explore-analyze/machine-learning/nlp/ml-nlp-inference.md +++ b/explore-analyze/machine-learning/nlp/ml-nlp-inference.md @@ -119,7 +119,7 @@ PUT ner-test ``` ::::{tip} -To use the `annotated_text` data type in this example, you must install the [mapper annotated text plugin](elasticsearch://reference/elasticsearch-plugins/mapper-annotated-text.md). For more installation details, refer to [Add plugins provided with {{ech}}](elasticsearch://reference/elasticsearch-plugins/plugin-management.md). +To use the `annotated_text` data type in this example, you must install the [mapper annotated text plugin](elasticsearch://reference/elasticsearch-plugins/mapper-annotated-text.md). :::: You can then use the new pipeline to index some documents. For example, use a bulk indexing request with the `pipeline` query parameter for your NER pipeline: