From 2d543df1bfd5fb9bc4684867da817db344fd4e75 Mon Sep 17 00:00:00 2001 From: Kuni Sen <30574753+kunisen@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:23:27 +0900 Subject: [PATCH 1/3] Clarify bundle update content Highlight an important piece and add a best practice. Without noticing this piece, user may update their bundle and break their nodes. Also, bundle gets reflected to deployment during node start, so this may cause further confusion if user updated the bundle wrongly but didn't restart the node, until our system maintenance happens and move the node, and thus make the issue surfacing. --- .../deploy/elastic-cloud/upload-custom-plugins-bundles.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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 aa31f2e4b0..1ee4ebb2bd 100644 --- a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md +++ b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md @@ -151,7 +151,13 @@ After uploading your files, you can select to enable them when creating a new {{ While you can update the ZIP file for any plugin or bundle, these are downloaded and made available only when a node is started. -You should be careful when updating an extension. If you update an existing extension with a new file, and if the file is broken for some reason, all the nodes could be in trouble, as a restart or move node could make even HA clusters non-available. +:::{important} +You should be careful when updating an extension. If you update an existing extension with a new file, and if the file is broken for some reason, all the nodes could be in trouble, as a restart or move node could make even HA clusters non-available. Also, shards of your indices may become unassigned there's anything wrong with the bundle, for example, file being referenced by index is missing due to the update. +::: + +:::{tip} +If you need to make update to your extension, instead of updating an existing extension with a new file directly, we recommend you to create a new extension to test the behavior first, verify it's validty, and then reflect it to your deployment. +::: If the extension is not in use by any deployments, then you are free to update the files or extension details as much as you like. However, if the extension is in use, and if you need to update it with a new file, it is recommended to [create a new extension](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ec-add-your-plugin) rather than updating the existing one that is in use. From 5818b1d4436bbf0832dc10c6917f0d623612f6e7 Mon Sep 17 00:00:00 2001 From: Kuni Sen <30574753+kunisen@users.noreply.github.com> Date: Mon, 4 Aug 2025 11:29:35 +0900 Subject: [PATCH 2/3] Update deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> --- .../deploy/elastic-cloud/upload-custom-plugins-bundles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 1ee4ebb2bd..b9136343cb 100644 --- a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md +++ b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md @@ -152,7 +152,7 @@ After uploading your files, you can select to enable them when creating a new {{ While you can update the ZIP file for any plugin or bundle, these are downloaded and made available only when a node is started. :::{important} -You should be careful when updating an extension. If you update an existing extension with a new file, and if the file is broken for some reason, all the nodes could be in trouble, as a restart or move node could make even HA clusters non-available. Also, shards of your indices may become unassigned there's anything wrong with the bundle, for example, file being referenced by index is missing due to the update. +Be careful when updating an extension. If you update an existing extension with a new file, and if the file is broken for any reason, all the nodes could be impacted, as either a restart or a move node could make even HA clusters non-available. Also, shards of your indices may become unassigned if there's anything wrong with the bundle, for example if a file referenced by an index is missing due to the update. ::: :::{tip} From 52a49bc5b9fd79bbb9400f3dff20dcf50fa4be33 Mon Sep 17 00:00:00 2001 From: Kuni Sen <30574753+kunisen@users.noreply.github.com> Date: Mon, 4 Aug 2025 11:30:03 +0900 Subject: [PATCH 3/3] Update deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> --- .../deploy/elastic-cloud/upload-custom-plugins-bundles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 b9136343cb..972e90c0c0 100644 --- a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md +++ b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md @@ -156,7 +156,7 @@ Be careful when updating an extension. If you update an existing extension with ::: :::{tip} -If you need to make update to your extension, instead of updating an existing extension with a new file directly, we recommend you to create a new extension to test the behavior first, verify it's validty, and then reflect it to your deployment. +If you need to update your extension, instead of updating an existing extension with a new file directly, we recommend that you create a new extension to test the behavior first, verify it's validity, and then reflect it to your deployment. ::: If the extension is not in use by any deployments, then you are free to update the files or extension details as much as you like. However, if the extension is in use, and if you need to update it with a new file, it is recommended to [create a new extension](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ec-add-your-plugin) rather than updating the existing one that is in use.