From 7f0b1a1af5296d9ecca412535680030e5dd13b11 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Mon, 29 Dec 2025 16:46:45 +0000 Subject: [PATCH 01/14] Fixing applies_to tags part of #4117 Replacing all the tags on the page with stack as it applies to all deployments. The tab titles were also wrong, they should be split as UI vs API instructions. --- .../elasticsearch/all-shards-failed.md | 5 ----- .../allow-all-cluster-allocation.md | 21 ++++++------------- 2 files changed, 6 insertions(+), 20 deletions(-) diff --git a/troubleshoot/elasticsearch/all-shards-failed.md b/troubleshoot/elasticsearch/all-shards-failed.md index ddb642659c..a70532dd91 100644 --- a/troubleshoot/elasticsearch/all-shards-failed.md +++ b/troubleshoot/elasticsearch/all-shards-failed.md @@ -1,11 +1,6 @@ --- applies_to: stack: - deployment: - eck: - ess: - ece: - self: navigation_title: "Error: All shards failed" --- diff --git a/troubleshoot/elasticsearch/allow-all-cluster-allocation.md b/troubleshoot/elasticsearch/allow-all-cluster-allocation.md index dc9cf5e381..128a8d0bcb 100644 --- a/troubleshoot/elasticsearch/allow-all-cluster-allocation.md +++ b/troubleshoot/elasticsearch/allow-all-cluster-allocation.md @@ -4,11 +4,6 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/allow-all-cluster-allocation.html applies_to: stack: - deployment: - eck: - ess: - ece: - self: products: - id: elasticsearch --- @@ -19,16 +14,15 @@ The allocation of data in an {{es}} deployment can be controlled using the [enab Forgetting to re-allow all data allocations can lead to unassigned shards. -In order to (re)allow all data to be allocated follow these steps: +To get the shards assigned we need to change the value of the [configuration](elasticsearch://reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md#cluster-routing-allocation-enable) that restricts the assignment of the shards to allow all shards to be allocated. -:::::::{tab-set} +We achieve this by inspecting the system-wide `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) and changing the configured value to `all`. -::::::{tab-item} {{ech}} -In order to get the shards assigned we’ll need to change the value of the [configuration](elasticsearch://reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md#cluster-routing-allocation-enable) that restricts the assignemnt of the shards to allow all shards to be allocated. +To (re)allow all data to be allocated, follow these steps: -We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) and changing the configured value to `all`. +:::::::{tab-set} -**Use {{kib}}** +::::::{tab-item} {{kib}} 1. Log in to the [{{ecloud}} console](https://cloud.elastic.co?page=docs&placement=docs-body). 2. On the **Hosted deployments** panel, click the name of your deployment. @@ -77,10 +71,7 @@ We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.e 1. The new value for the `allocation.enable` system-wide configuration is changed to allow all the shards to be allocated. :::::: -::::::{tab-item} Self-managed -In order to get the shards assigned we’ll need to change the value of the [configuration](elasticsearch://reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md#cluster-routing-allocation-enable) that restricts the assignemnt of the shards to allow all shards to be allocated. - -We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) and changing the configured value to `all`. +::::::{tab-item} API 1. Inspect the `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings): From dd24916d665005708c5a1abcffb500bdd6586819 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Mon, 29 Dec 2025 17:08:28 +0000 Subject: [PATCH 02/14] Updating tab headers for alignment --- troubleshoot/elasticsearch/add-tier.md | 4 ++-- troubleshoot/elasticsearch/allow-all-cluster-allocation.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/troubleshoot/elasticsearch/add-tier.md b/troubleshoot/elasticsearch/add-tier.md index 11ebcb0760..85bf7d4652 100644 --- a/troubleshoot/elasticsearch/add-tier.md +++ b/troubleshoot/elasticsearch/add-tier.md @@ -20,7 +20,7 @@ In order to allow indices to be allocated, follow these steps to add the [data t :::::::{tab-set} -::::::{tab-item} {{kib}} +::::::{tab-item} Using {{kib}} In order to get the shards assigned we need enable a new tier in the deployment. @@ -64,7 +64,7 @@ In order to get the shards assigned we need enable a new tier in the deployment. 8. Navigate to the bottom of the page and click the **Save** button. :::::: -::::::{tab-item} API +::::::{tab-item} Using the {{es}} API In order to get the shards assigned you can add more nodes to your {{es}} cluster and assign the index’s target tier [node role](../../manage-data/lifecycle/index-lifecycle-management/migrate-index-allocation-filters-to-node-roles.md#assign-data-tier) to the new nodes. To determine which tier an index requires for assignment, use the [get index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting: diff --git a/troubleshoot/elasticsearch/allow-all-cluster-allocation.md b/troubleshoot/elasticsearch/allow-all-cluster-allocation.md index 128a8d0bcb..fb7009979d 100644 --- a/troubleshoot/elasticsearch/allow-all-cluster-allocation.md +++ b/troubleshoot/elasticsearch/allow-all-cluster-allocation.md @@ -22,7 +22,7 @@ To (re)allow all data to be allocated, follow these steps: :::::::{tab-set} -::::::{tab-item} {{kib}} +::::::{tab-item} Using {{kib}} 1. Log in to the [{{ecloud}} console](https://cloud.elastic.co?page=docs&placement=docs-body). 2. On the **Hosted deployments** panel, click the name of your deployment. @@ -71,7 +71,7 @@ To (re)allow all data to be allocated, follow these steps: 1. The new value for the `allocation.enable` system-wide configuration is changed to allow all the shards to be allocated. :::::: -::::::{tab-item} API +::::::{tab-item} Using the {{es}} API 1. Inspect the `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings): From ba19ed386ad61c339cc74b7e3f95c58ed37b1be3 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Mon, 29 Dec 2025 17:11:40 +0000 Subject: [PATCH 03/14] Working in a few more updates for the index allocation page --- .../elasticsearch/allow-all-index-allocation.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/troubleshoot/elasticsearch/allow-all-index-allocation.md b/troubleshoot/elasticsearch/allow-all-index-allocation.md index caa2c2cac2..c7156cc971 100644 --- a/troubleshoot/elasticsearch/allow-all-index-allocation.md +++ b/troubleshoot/elasticsearch/allow-all-index-allocation.md @@ -4,11 +4,6 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/allow-all-index-allocation.html applies_to: stack: - deployment: - eck: - ess: - ece: - self: products: - id: elasticsearch --- @@ -22,14 +17,14 @@ The allocation of data can be controlled using the [enable allocation configurat Forgetting to re-allow all data allocation can lead to unassigned shards. +In order to get the shards assigned we’ll need to change the value of the [configuration](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-routing-allocation-enable-setting) that restricts the assignment of the shards to `all`. + In order to (re)allow all data to be allocated follow these steps: :::::::{tab-set} -::::::{tab-item} {{ech}} -In order to get the shards assigned we’ll need to change the value of the [configuration](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-routing-allocation-enable-setting) that restricts the assignemnt of the shards to `all`. +::::::{tab-item} Using {{kib}} -**Use {{kib}}** 1. Log in to the [{{ecloud}} console](https://cloud.elastic.co?page=docs&placement=docs-body). 2. On the **Hosted deployments** panel, click the name of your deployment. @@ -79,8 +74,7 @@ In order to get the shards assigned we’ll need to change the value of the [con 1. The new value for the `allocation.enable` configuration for the `my-index-000001` index is changed to allow all the shards to be allocated. :::::: -::::::{tab-item} Self-managed -In order to get the shards assigned we’ll need to change the value of the [configuration](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-routing-allocation-enable-setting) that restricts the assignemnt of the shards to `all`. +::::::{tab-item} Using the {{es}} API 1. Inspect the `index.routing.allocation.enable` [index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) for the index with unassigned shards: From 40453f46f5cf76ff330397f5a4310441628668c2 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Mon, 29 Dec 2025 17:22:39 +0000 Subject: [PATCH 04/14] Tidying up tags for the Circuit breaker errors --- deploy-manage/_snippets/autoops-callout-with-ech.md | 2 +- troubleshoot/elasticsearch/circuit-breaker-errors.md | 5 ----- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/deploy-manage/_snippets/autoops-callout-with-ech.md b/deploy-manage/_snippets/autoops-callout-with-ech.md index b40ad75757..fd9cfba38b 100644 --- a/deploy-manage/_snippets/autoops-callout-with-ech.md +++ b/deploy-manage/_snippets/autoops-callout-with-ech.md @@ -1,4 +1,4 @@ :::{admonition} Simplify monitoring with AutoOps -:applies_to: { ess:, ece:, eck:, self:, "serverless": "ga" } +:applies_to: { "stack": "ga", "serverless": "ga" } AutoOps is a monitoring tool that simplifies cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths. Learn more about [](/deploy-manage/monitor/autoops.md). ::: \ No newline at end of file diff --git a/troubleshoot/elasticsearch/circuit-breaker-errors.md b/troubleshoot/elasticsearch/circuit-breaker-errors.md index 6c170e614b..c868d5461c 100644 --- a/troubleshoot/elasticsearch/circuit-breaker-errors.md +++ b/troubleshoot/elasticsearch/circuit-breaker-errors.md @@ -3,11 +3,6 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/circuit-breaker-errors.html applies_to: stack: - deployment: - eck: - ess: - ece: - self: products: - id: elasticsearch --- From 4a93ed0d4003bf9b9ab3086751af5c8b6d23f297 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Mon, 29 Dec 2025 17:29:03 +0000 Subject: [PATCH 05/14] Fixing the Troubleshoot data corruption tags --- troubleshoot/elasticsearch/corruption-troubleshooting.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/troubleshoot/elasticsearch/corruption-troubleshooting.md b/troubleshoot/elasticsearch/corruption-troubleshooting.md index 6e2b13779d..c4a76978cf 100644 --- a/troubleshoot/elasticsearch/corruption-troubleshooting.md +++ b/troubleshoot/elasticsearch/corruption-troubleshooting.md @@ -4,11 +4,6 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/corruption-troubleshooting.html applies_to: stack: - deployment: - eck: - ess: - ece: - self: products: - id: elasticsearch --- From 9e3998f17f569b142917e6e92f6dd6226b2d5749 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Tue, 30 Dec 2025 10:18:37 +0000 Subject: [PATCH 06/14] Update topics to remove unnecessary tabs --- troubleshoot/elasticsearch/add-tier.md | 55 ++--------------- .../allow-all-cluster-allocation.md | 59 +------------------ .../allow-all-index-allocation.md | 59 +------------------ 3 files changed, 9 insertions(+), 164 deletions(-) diff --git a/troubleshoot/elasticsearch/add-tier.md b/troubleshoot/elasticsearch/add-tier.md index 85bf7d4652..936e3feebf 100644 --- a/troubleshoot/elasticsearch/add-tier.md +++ b/troubleshoot/elasticsearch/add-tier.md @@ -16,56 +16,11 @@ products: The allocation of indices in an {{es}} deployment can be allocated on [data tiers](../../manage-data/lifecycle/data-tiers.md). -In order to allow indices to be allocated, follow these steps to add the [data tier](../../manage-data/lifecycle/data-tiers.md) the indices expect to be allocated on to your deployment: +To allow indices to be allocated, follow these steps. -:::::::{tab-set} +You can run the following steps using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls. -::::::{tab-item} Using {{kib}} -In order to get the shards assigned we need enable a new tier in the deployment. - - -1. Log in to the [{{ecloud}} console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the **Hosted deployments** panel, click the name of your deployment. - - ::::{note} - If the name of your deployment is disabled your {{kib}} instances might be unhealthy, in which case contact [Elastic Support](https://support.elastic.co). If your deployment doesn’t include {{kib}}, all you need to do is [enable it first](../../deploy-manage/deploy/elastic-cloud/access-kibana.md). - :::: - -3. Open your deployment’s side navigation menu (placed under the Elastic logo in the upper left corner) and go to **Dev Tools > Console**. - - :::{image} /troubleshoot/images/elasticsearch-reference-kibana-console.png - :alt: {{kib}} Console - :screenshot: - ::: - -4. Determine which tier an index expects for assignment. [Retrieve](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) the configured value for the `index.routing.allocation.include._tier_preference` setting: - - ```console - GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings - ``` - - The response will look like this: - - ```console-result - { - "my-index-000001": { - "settings": { - "index.routing.allocation.include._tier_preference": "data_warm,data_hot" <1> - } - } - } - ``` - - 1. Represents a comma-separated list of data tier node roles this index is allowed to be allocated on, the first one in the list being the one with the higher priority i.e. the tier the index is targeting. e.g. in this example the tier preference is `data_warm,data_hot` so the index is targeting the `warm` tier and more nodes with the `data_warm` role are needed in the {{es}} cluster. - -5. Open your deployment’s side navigation menu (placed under the Elastic logo in the upper left corner) and go to **Manage this deployment**. -6. From the right hand side, click to expand the **Manage** dropdown button and select **Edit deployment** from the list of options. -7. On the **Edit** page, click on **+ Add Capacity** for the tier you identified you need to enable in your deployment. Choose the desired size and availability zones for the new tier. -8. Navigate to the bottom of the page and click the **Save** button. -:::::: - -::::::{tab-item} Using the {{es}} API -In order to get the shards assigned you can add more nodes to your {{es}} cluster and assign the index’s target tier [node role](../../manage-data/lifecycle/index-lifecycle-management/migrate-index-allocation-filters-to-node-roles.md#assign-data-tier) to the new nodes. +To get the shards assigned, you can add more nodes to your {{es}} cluster and assign the index’s target tier [node role](../../manage-data/lifecycle/index-lifecycle-management/migrate-index-allocation-filters-to-node-roles.md#assign-data-tier) to the new nodes. To determine which tier an index requires for assignment, use the [get index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting: @@ -73,7 +28,7 @@ To determine which tier an index requires for assignment, use the [get index set GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings ``` -The response will look like this: +The response looks like this: ```console-result { @@ -86,6 +41,4 @@ The response will look like this: ``` 1. Represents a comma-separated list of data tier node roles this index is allowed to be allocated on, the first one in the list being the one with the higher priority i.e. the tier the index is targeting. e.g. in this example the tier preference is `data_warm,data_hot` so the index is targeting the `warm` tier and more nodes with the `data_warm` role are needed in the {{es}} cluster. -:::::: -::::::: diff --git a/troubleshoot/elasticsearch/allow-all-cluster-allocation.md b/troubleshoot/elasticsearch/allow-all-cluster-allocation.md index fb7009979d..2420cfa760 100644 --- a/troubleshoot/elasticsearch/allow-all-cluster-allocation.md +++ b/troubleshoot/elasticsearch/allow-all-cluster-allocation.md @@ -18,60 +18,10 @@ To get the shards assigned we need to change the value of the [configuration](el We achieve this by inspecting the system-wide `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) and changing the configured value to `all`. -To (re)allow all data to be allocated, follow these steps: +To allow all data to be allocated, follow these steps. -:::::::{tab-set} +You can run the following steps using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls. -::::::{tab-item} Using {{kib}} - -1. Log in to the [{{ecloud}} console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the **Hosted deployments** panel, click the name of your deployment. - - ::::{note} - If the name of your deployment is disabled your {{kib}} instances might be unhealthy, in which case contact [Elastic Support](https://support.elastic.co). If your deployment doesn’t include {{kib}}, all you need to do is [enable it first](../../deploy-manage/deploy/elastic-cloud/access-kibana.md). - :::: - -3. Open your deployment’s side navigation menu (placed under the Elastic logo in the upper left corner) and go to **Dev Tools > Console**. - - :::{image} /troubleshoot/images/elasticsearch-reference-kibana-console.png - :alt: {{kib}} Console - :screenshot: - ::: - -4. Inspect the `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings): - - ```console - GET /_cluster/settings?flat_settings - ``` - - The response will look like this: - - ```console-result - { - "persistent": { - "cluster.routing.allocation.enable": "none" <1> - }, - "transient": {} - } - ``` - - 1. Represents the current configured value that controls if data is partially or fully allowed to be allocated in the system. - -5. [Change](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) the [configuration](elasticsearch://reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md#cluster-routing-allocation-enable) value to allow all the data in the system to be fully allocated: - - ```console - PUT _cluster/settings - { - "persistent" : { - "cluster.routing.allocation.enable" : "all" <1> - } - } - ``` - - 1. The new value for the `allocation.enable` system-wide configuration is changed to allow all the shards to be allocated. -:::::: - -::::::{tab-item} Using the {{es}} API 1. Inspect the `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings): @@ -103,7 +53,4 @@ To (re)allow all data to be allocated, follow these steps: } ``` - 1. The new value for the `allocation.enable` system-wide configuration is changed to allow all the shards to be allocated. -:::::: - -::::::: + 1. The new value for the `allocation.enable` system-wide configuration is changed to allow all the shards to be allocated. \ No newline at end of file diff --git a/troubleshoot/elasticsearch/allow-all-index-allocation.md b/troubleshoot/elasticsearch/allow-all-index-allocation.md index c7156cc971..33991aaa97 100644 --- a/troubleshoot/elasticsearch/allow-all-index-allocation.md +++ b/troubleshoot/elasticsearch/allow-all-index-allocation.md @@ -19,62 +19,9 @@ Forgetting to re-allow all data allocation can lead to unassigned shards. In order to get the shards assigned we’ll need to change the value of the [configuration](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-routing-allocation-enable-setting) that restricts the assignment of the shards to `all`. -In order to (re)allow all data to be allocated follow these steps: +To allow all data to be allocated, follow these steps. -:::::::{tab-set} - -::::::{tab-item} Using {{kib}} - - -1. Log in to the [{{ecloud}} console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the **Hosted deployments** panel, click the name of your deployment. - - ::::{note} - If the name of your deployment is disabled your {{kib}} instances might be unhealthy, in which case contact [Elastic Support](https://support.elastic.co). If your deployment doesn’t include {{kib}}, all you need to do is [enable it first](../../deploy-manage/deploy/elastic-cloud/access-kibana.md). - :::: - -3. Open your deployment’s side navigation menu (placed under the Elastic logo in the upper left corner) and go to **Dev Tools > Console**. - - :::{image} /troubleshoot/images/elasticsearch-reference-kibana-console.png - :alt: {{kib}} Console - :screenshot: - ::: - -4. Inspect the `index.routing.allocation.enable` [index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) for the index with unassigned shards: - - ```console - GET /my-index-000001/_settings/index.routing.allocation.enable?flat_settings - ``` - - The response will look like this: - - ```console-result - { - "my-index-000001": { - "settings": { - "index.routing.allocation.enable": "none" <1> - } - } - } - ``` - - 1. Represents the current configured value that controls if the index is allowed to be partially or totally allocated. - -5. [Change](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings) the [configuration](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-routing-allocation-enable-setting) value to allow the index to be fully allocated: - - ```console - PUT /my-index-000001/_settings - { - "index" : { - "routing.allocation.enable" : "all" <1> - } - } - ``` - - 1. The new value for the `allocation.enable` configuration for the `my-index-000001` index is changed to allow all the shards to be allocated. -:::::: - -::::::{tab-item} Using the {{es}} API +You can run the following steps using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls. 1. Inspect the `index.routing.allocation.enable` [index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) for the index with unassigned shards: @@ -108,6 +55,4 @@ In order to (re)allow all data to be allocated follow these steps: ``` 1. The new value for the `allocation.enable` configuration for the `my-index-000001` index is changed to allow all the shards to be allocated. -:::::: -::::::: From aaaf76b0a78addf457272b7028f251f5641a601c Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Tue, 30 Dec 2025 10:24:35 +0000 Subject: [PATCH 07/14] reverting the autoops snippet change --- deploy-manage/_snippets/autoops-callout-with-ech.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/_snippets/autoops-callout-with-ech.md b/deploy-manage/_snippets/autoops-callout-with-ech.md index fd9cfba38b..b40ad75757 100644 --- a/deploy-manage/_snippets/autoops-callout-with-ech.md +++ b/deploy-manage/_snippets/autoops-callout-with-ech.md @@ -1,4 +1,4 @@ :::{admonition} Simplify monitoring with AutoOps -:applies_to: { "stack": "ga", "serverless": "ga" } +:applies_to: { ess:, ece:, eck:, self:, "serverless": "ga" } AutoOps is a monitoring tool that simplifies cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths. Learn more about [](/deploy-manage/monitor/autoops.md). ::: \ No newline at end of file From 72f0756b8400eb895408e88458b423f1ad8f8ff0 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Tue, 30 Dec 2025 12:42:40 +0000 Subject: [PATCH 08/14] Adding correct tags to Troubleshoot data corruption --- troubleshoot/elasticsearch/corruption-troubleshooting.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/troubleshoot/elasticsearch/corruption-troubleshooting.md b/troubleshoot/elasticsearch/corruption-troubleshooting.md index c4a76978cf..69db953276 100644 --- a/troubleshoot/elasticsearch/corruption-troubleshooting.md +++ b/troubleshoot/elasticsearch/corruption-troubleshooting.md @@ -3,7 +3,10 @@ navigation_title: Data corruption mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/corruption-troubleshooting.html applies_to: - stack: + deployment: + eck: + ece: + self: products: - id: elasticsearch --- From 05bd5a639e102ab06ade6ed4a483cce67d5c0f05 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Wed, 31 Dec 2025 12:20:52 +0000 Subject: [PATCH 09/14] Update the Preferred data tier page as per review feedback --- troubleshoot/elasticsearch/add-tier.md | 44 +++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 4 deletions(-) diff --git a/troubleshoot/elasticsearch/add-tier.md b/troubleshoot/elasticsearch/add-tier.md index 936e3feebf..2fa4902bbf 100644 --- a/troubleshoot/elasticsearch/add-tier.md +++ b/troubleshoot/elasticsearch/add-tier.md @@ -14,15 +14,48 @@ products: # Add a preferred data tier to a deployment [add-tier] -The allocation of indices in an {{es}} deployment can be allocated on [data tiers](../../manage-data/lifecycle/data-tiers.md). +In an {{es}} deployment, an index and its shards can be allocated to [data tiers](../../manage-data/lifecycle/data-tiers.md) using routing and allocation settings. To allow indices to be allocated, follow these steps. -You can run the following steps using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls. +:::::::{applies-switch} -To get the shards assigned, you can add more nodes to your {{es}} cluster and assign the index’s target tier [node role](../../manage-data/lifecycle/index-lifecycle-management/migrate-index-allocation-filters-to-node-roles.md#assign-data-tier) to the new nodes. +::::::{applies-item} { ess: } +To get the shards assigned, you need to enable a new tier in the deployment. -To determine which tier an index requires for assignment, use the [get index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting: +You can run the following step using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls. + +1. Determine which tier an index requires to be assigned to. [Retrieve](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) the configured value for the `index.routing.allocation.include._tier_preference` setting: + + ```console + GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings + ``` + + The response will look like this: + + ```console-result + { + "my-index-000001": { + "settings": { + "index.routing.allocation.include._tier_preference": "data_warm,data_hot" <1> + } + } + } + ``` + + 1. Represents a comma-separated list of data tier node roles this index is allowed to be allocated on, the first one in the list being the one with the higher priority i.e. the tier the index is targeting. e.g. in this example the tier preference is `data_warm,data_hot` so the index is targeting the `warm` tier and more nodes with the `data_warm` role are needed in the {{es}} cluster. + +1. In {{kib}}, open your deployment’s navigation menu (placed under the Elastic logo in the upper left corner) and go to **Manage this deployment**. +1. From the right hand side, click to expand the **Manage** dropdown button and select **Edit deployment** from the list of options. +1. On the **Edit** page, click on **+ Add Capacity** for the tier you identified you need to enable in your deployment. Choose the desired size and availability zones for the new tier. +1. Navigate to the bottom of the page and click the **Save** button. +:::::: + +::::::{applies-item} { self: } + +To get the shards assigned, add more nodes to your {{es}} cluster and assign the index’s target tier [node role](/manage-data/lifecycle/data-tiers.md#configure-data-tiers-on-premise) to the new nodes. + +To determine which tier an index requires to be assigned to, use the [get index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting: ```console GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings @@ -42,3 +75,6 @@ The response looks like this: 1. Represents a comma-separated list of data tier node roles this index is allowed to be allocated on, the first one in the list being the one with the higher priority i.e. the tier the index is targeting. e.g. in this example the tier preference is `data_warm,data_hot` so the index is targeting the `warm` tier and more nodes with the `data_warm` role are needed in the {{es}} cluster. +:::::: + +::::::: \ No newline at end of file From 18a1f7078fccf19ad7b405ad231e0ab9a4a4d845 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Wed, 31 Dec 2025 13:09:58 +0000 Subject: [PATCH 10/14] Adding note to Troubleshooting data corruption --- troubleshoot/elasticsearch/add-tier.md | 4 ++-- troubleshoot/elasticsearch/corruption-troubleshooting.md | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/troubleshoot/elasticsearch/add-tier.md b/troubleshoot/elasticsearch/add-tier.md index 2fa4902bbf..94ae6859cc 100644 --- a/troubleshoot/elasticsearch/add-tier.md +++ b/troubleshoot/elasticsearch/add-tier.md @@ -25,7 +25,7 @@ To get the shards assigned, you need to enable a new tier in the deployment. You can run the following step using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls. -1. Determine which tier an index requires to be assigned to. [Retrieve](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) the configured value for the `index.routing.allocation.include._tier_preference` setting: +1. Determine which tiers an index's shards can be allocated to. [Retrieve](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) the configured value for the `index.routing.allocation.include._tier_preference` setting: ```console GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings @@ -55,7 +55,7 @@ You can run the following step using either [API console](/explore-analyze/query To get the shards assigned, add more nodes to your {{es}} cluster and assign the index’s target tier [node role](/manage-data/lifecycle/data-tiers.md#configure-data-tiers-on-premise) to the new nodes. -To determine which tier an index requires to be assigned to, use the [get index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting: +To determine which tiers an index's shards can be allocated to, use the [get index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting: ```console GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings diff --git a/troubleshoot/elasticsearch/corruption-troubleshooting.md b/troubleshoot/elasticsearch/corruption-troubleshooting.md index 69db953276..a041755139 100644 --- a/troubleshoot/elasticsearch/corruption-troubleshooting.md +++ b/troubleshoot/elasticsearch/corruption-troubleshooting.md @@ -13,6 +13,10 @@ products: # Troubleshoot data corruption [corruption-troubleshooting] +:::{note} +While this troubleshooting section applies to self-managed deployment types, {{ech}} and {{serverless-full}} deployments are designed to minimize the risk of data corruption through managed infrastructure and automated operations. If you encounter any of these issues in a managed Elastic Cloud environment, contact support. +::: + {{es}} expects that the data it reads from disk is exactly the data it previously wrote. If it detects that the data on disk is different from what it wrote then it will report some kind of exception such as: * `org.apache.lucene.index.CorruptIndexException` From 2748d8459adc5b30c7b67c90917d7090b96df7e5 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Wed, 31 Dec 2025 13:39:43 +0000 Subject: [PATCH 11/14] Add applies_to tags to the note admonition --- troubleshoot/elasticsearch/corruption-troubleshooting.md | 1 + 1 file changed, 1 insertion(+) diff --git a/troubleshoot/elasticsearch/corruption-troubleshooting.md b/troubleshoot/elasticsearch/corruption-troubleshooting.md index a041755139..b03ca2295e 100644 --- a/troubleshoot/elasticsearch/corruption-troubleshooting.md +++ b/troubleshoot/elasticsearch/corruption-troubleshooting.md @@ -14,6 +14,7 @@ products: # Troubleshoot data corruption [corruption-troubleshooting] :::{note} +:applies_to: {"serverless": "ga", "ess": "ga", } While this troubleshooting section applies to self-managed deployment types, {{ech}} and {{serverless-full}} deployments are designed to minimize the risk of data corruption through managed infrastructure and automated operations. If you encounter any of these issues in a managed Elastic Cloud environment, contact support. ::: From fb763390663d086b98db71cc307538acd155a1dd Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Wed, 31 Dec 2025 13:46:06 +0000 Subject: [PATCH 12/14] changed some wording based on other examples --- troubleshoot/elasticsearch/corruption-troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/troubleshoot/elasticsearch/corruption-troubleshooting.md b/troubleshoot/elasticsearch/corruption-troubleshooting.md index b03ca2295e..ee33addcf1 100644 --- a/troubleshoot/elasticsearch/corruption-troubleshooting.md +++ b/troubleshoot/elasticsearch/corruption-troubleshooting.md @@ -15,7 +15,7 @@ products: :::{note} :applies_to: {"serverless": "ga", "ess": "ga", } -While this troubleshooting section applies to self-managed deployment types, {{ech}} and {{serverless-full}} deployments are designed to minimize the risk of data corruption through managed infrastructure and automated operations. If you encounter any of these issues in a managed Elastic Cloud environment, contact support. +While this section applies to troubleshooting fully self-managed {{es}} clusters, {{ech}} and {{serverless-full}} deployments are designed to minimize the risk of data corruption through managed infrastructure and automated operations. If you encounter any of these issues in a managed Elastic Cloud environment, contact support. ::: {{es}} expects that the data it reads from disk is exactly the data it previously wrote. If it detects that the data on disk is different from what it wrote then it will report some kind of exception such as: From d7ad0fc1226080254bb0a214f41a9b4d8c7c9d19 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Wed, 31 Dec 2025 17:17:23 +0000 Subject: [PATCH 13/14] Making more edits as per review suggestions --- troubleshoot/elasticsearch/add-tier.md | 63 +++++++++---------- .../corruption-troubleshooting.md | 2 +- 2 files changed, 30 insertions(+), 35 deletions(-) diff --git a/troubleshoot/elasticsearch/add-tier.md b/troubleshoot/elasticsearch/add-tier.md index 94ae6859cc..8f3c6d9a4a 100644 --- a/troubleshoot/elasticsearch/add-tier.md +++ b/troubleshoot/elasticsearch/add-tier.md @@ -16,44 +16,15 @@ products: In an {{es}} deployment, an index and its shards can be allocated to [data tiers](../../manage-data/lifecycle/data-tiers.md) using routing and allocation settings. -To allow indices to be allocated, follow these steps. +To allow indices to be allocated, follow these steps: -:::::::{applies-switch} - -::::::{applies-item} { ess: } -To get the shards assigned, you need to enable a new tier in the deployment. - -You can run the following step using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls. - -1. Determine which tiers an index's shards can be allocated to. [Retrieve](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) the configured value for the `index.routing.allocation.include._tier_preference` setting: - - ```console - GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings - ``` - - The response will look like this: - - ```console-result - { - "my-index-000001": { - "settings": { - "index.routing.allocation.include._tier_preference": "data_warm,data_hot" <1> - } - } - } - ``` +1. [Determine which tiers](#determine-target-tier) an index's shards can be allocated to. +1. [Resize your deployment](#resize-your-deployment). - 1. Represents a comma-separated list of data tier node roles this index is allowed to be allocated on, the first one in the list being the one with the higher priority i.e. the tier the index is targeting. e.g. in this example the tier preference is `data_warm,data_hot` so the index is targeting the `warm` tier and more nodes with the `data_warm` role are needed in the {{es}} cluster. -1. In {{kib}}, open your deployment’s navigation menu (placed under the Elastic logo in the upper left corner) and go to **Manage this deployment**. -1. From the right hand side, click to expand the **Manage** dropdown button and select **Edit deployment** from the list of options. -1. On the **Edit** page, click on **+ Add Capacity** for the tier you identified you need to enable in your deployment. Choose the desired size and availability zones for the new tier. -1. Navigate to the bottom of the page and click the **Save** button. -:::::: +## Determine the target tier [determine-target-tier] -::::::{applies-item} { self: } - -To get the shards assigned, add more nodes to your {{es}} cluster and assign the index’s target tier [node role](/manage-data/lifecycle/data-tiers.md#configure-data-tiers-on-premise) to the new nodes. +You can run the following step using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls. To determine which tiers an index's shards can be allocated to, use the [get index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting: @@ -75,6 +46,30 @@ The response looks like this: 1. Represents a comma-separated list of data tier node roles this index is allowed to be allocated on, the first one in the list being the one with the higher priority i.e. the tier the index is targeting. e.g. in this example the tier preference is `data_warm,data_hot` so the index is targeting the `warm` tier and more nodes with the `data_warm` role are needed in the {{es}} cluster. +## Resize your deployment [resize-your-deployment] + + + +:::::::{applies-switch} + +::::::{applies-item} { ess:, ece: } +To enable a new tier in your {{ech}} deployment, you edit the deployment topology to add a new data tier. + +1. In {{kib}}, open your deployment’s navigation menu (placed under the Elastic logo in the upper left corner) and go to **Manage this deployment**. +1. From the right hand side, click to expand the **Manage** dropdown button and select **Edit deployment** from the list of options. +1. On the **Edit** page, click on **+ Add Capacity** for the tier you identified you need to enable in your deployment. Choose the desired size and availability zones for the new tier. +1. Navigate to the bottom of the page and click the **Save** button. +:::::: + +::::::{applies-item} { self: } + +Add more nodes to your {{es}} cluster and assign the index’s target tier [node role](/manage-data/lifecycle/data-tiers.md#configure-data-tiers-on-premise) to the new nodes, by adjusting the configuration in `elasticsearch.yml`. +:::::: + + +::::::{applies-item} { eck: } +Add more nodes to your {{es}} cluster and assign the index’s target tier [node role](/deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md/#change-node-role) to the new nodes, by adjusting the [node configuration](/deploy-manage/deploy/cloud-on-k8s/node-configuration.md) in the `spec` section of your {{es}} resource manifest. + :::::: ::::::: \ No newline at end of file diff --git a/troubleshoot/elasticsearch/corruption-troubleshooting.md b/troubleshoot/elasticsearch/corruption-troubleshooting.md index ee33addcf1..464f5bb196 100644 --- a/troubleshoot/elasticsearch/corruption-troubleshooting.md +++ b/troubleshoot/elasticsearch/corruption-troubleshooting.md @@ -15,7 +15,7 @@ products: :::{note} :applies_to: {"serverless": "ga", "ess": "ga", } -While this section applies to troubleshooting fully self-managed {{es}} clusters, {{ech}} and {{serverless-full}} deployments are designed to minimize the risk of data corruption through managed infrastructure and automated operations. If you encounter any of these issues in a managed Elastic Cloud environment, contact support. +While this section applies to troubleshooting fully self-managed {{es}} clusters, {{ech}} deployments and {{serverless-full}} projects are designed to minimize the risk of data corruption through managed infrastructure and automated operations. If you encounter any of these issues in {{ecloud}}, contact Elastic Support. ::: {{es}} expects that the data it reads from disk is exactly the data it previously wrote. If it detects that the data on disk is different from what it wrote then it will report some kind of exception such as: From 5cd80d37c9c2b875eecb6be0fb9fb2c0d7f3b911 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Wed, 31 Dec 2025 17:25:51 +0000 Subject: [PATCH 14/14] Fix broken link --- troubleshoot/elasticsearch/add-tier.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/troubleshoot/elasticsearch/add-tier.md b/troubleshoot/elasticsearch/add-tier.md index 8f3c6d9a4a..7bde89bfe8 100644 --- a/troubleshoot/elasticsearch/add-tier.md +++ b/troubleshoot/elasticsearch/add-tier.md @@ -68,7 +68,7 @@ Add more nodes to your {{es}} cluster and assign the index’s target tier [node ::::::{applies-item} { eck: } -Add more nodes to your {{es}} cluster and assign the index’s target tier [node role](/deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md/#change-node-role) to the new nodes, by adjusting the [node configuration](/deploy-manage/deploy/cloud-on-k8s/node-configuration.md) in the `spec` section of your {{es}} resource manifest. +Add more nodes to your {{es}} cluster and assign the index’s target tier [node role](/deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md#change-node-role) to the new nodes, by adjusting the [node configuration](/deploy-manage/deploy/cloud-on-k8s/node-configuration.md) in the `spec` section of your {{es}} resource manifest. ::::::