-
Notifications
You must be signed in to change notification settings - Fork 240
Deduplicate some of the Plugin management content #7101
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,6 +4,7 @@ | |||||
| - 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 @@ | |||||
|
|
||||||
| # 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. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this doesn't align with the content below because it's very "included plugin" centric. we might want to better split the provided plugin / custom plugin narrative a bit |
||||||
|
|
||||||
| There are many suitable plugins, including: | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I feel like
Suggested change
|
||||||
|
|
||||||
| * 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] | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. as much as this process is teeny-tiny, I think it breaks the IA to put it here. the other procedures are child pages, which would make this a disambiguation page. I suggest moving it down a level. |
||||||
|
|
||||||
| 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 | ||||||
| ::: | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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] | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. does the extensions API stuff still belong on this page? if so, we have some heading gore we can probably clean up quick |
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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). | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. these should eventually be parallelized, but I'd always avoid hardcoding the link names
Suggested change
|
||||||
|
|
||||||
| :::{tip} | ||||||
| You should use these exact filenames for {{ecloud}} to recognize the file in the bundle. | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I prefer the acronym here but my pal claude tells me it's worse for llmo 😢