From 671fe3faac6232679c5e19dda185a7ff62395aba Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 24 Nov 2022 16:21:51 +0000 Subject: [PATCH] Clarify index recovery docs (#91861) Mentions that we only report on recoveries for shard copies that actually exist in the cluster, so you don't see all historical data if, e.g., the shard copy relocates elsewhere. --- docs/reference/indices/recovery.asciidoc | 27 +++++++++++++++--------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/reference/indices/recovery.asciidoc b/docs/reference/indices/recovery.asciidoc index 4a61155175d4d..81b3aa13580c0 100644 --- a/docs/reference/indices/recovery.asciidoc +++ b/docs/reference/indices/recovery.asciidoc @@ -4,10 +4,9 @@ Index recovery ++++ - -Returns information about ongoing and completed shard recoveries for one or more -indices. For data streams, the API returns information for the stream's backing -indices. +Returns information about ongoing and completed shard recoveries for one or +more indices. For data streams, the API returns information for the stream's +backing indices. [source,console] ---- @@ -33,14 +32,14 @@ index, or alias. [[index-recovery-api-desc]] ==== {api-description-title} -Use the index recovery API -to get information about ongoing and completed shard recoveries. +Use the index recovery API to get information about ongoing and completed shard +recoveries. // tag::shard-recovery-desc[] -Shard recovery is the process -of syncing a replica shard from a primary shard. -Upon completion, -the replica shard is available for search. +Shard recovery is the process of initializing a shard copy, such as restoring a +primary shard from a snapshot or syncing a replica shard from a primary shard. +When a shard recovery completes, the recovered shard is available for search +and indexing. Recovery automatically occurs during the following processes: @@ -52,6 +51,14 @@ Recovery automatically occurs during the following processes: <> operation. // end::shard-recovery-desc[] +The index recovery API reports information about completed recoveries only for +shard copies that currently exist in the cluster. It only reports the last +recovery for each shard copy and does not report historical information about +earlier recoveries, nor does it report information about the recoveries of +shard copies that no longer exist. This means that if a shard copy completes a +recovery and then {es} relocates it onto a different node then the information +about the original recovery will not be shown in the recovery API. + [[index-recovery-api-path-params]] ==== {api-path-parms-title}