add documentation

Signed-off-by: bansvaru <[email protected]>
linuxpi · Oct 18, 2023 · a59c5d3 · a59c5d3
1 parent 8a1fbec
commit a59c5d3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/server/src/main/java/org/opensearch/cluster/routing/IndexRoutingTable.java b/server/src/main/java/org/opensearch/cluster/routing/IndexRoutingTable.java
@@ -472,9 +472,9 @@ public Builder initializeAsRemoteStoreRestore(
                 }
                 IndexShardRoutingTable.Builder indexShardRoutingBuilder = new IndexShardRoutingTable.Builder(shardId);
                 IndexShardRoutingTable indexShardRoutingTable = indexShardRoutingTableMap.get(shardId);
-                if (forceRecoverAllPrimaries
-                    || indexShardRoutingTable == null
-                    || indexShardRoutingTable.primaryShard().unassigned()
+                if (forceRecoverAllPrimaries || indexShardRoutingTable == null || indexShardRoutingTable.primaryShard().unassigned()
+                // When remote indices are restored via remote metadata,
+                // the shards are left in INITIALIZING state with unassigned Reason as still CLUSTER_RECOVERED
                     || (indexShardRoutingTable.primaryShard().initializing()
                         && indexShardRoutingTable.primaryShard().unassignedInfo().getReason() == UnassignedInfo.Reason.CLUSTER_RECOVERED)) {
                     // Primary shard to be recovered from remote store.

diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShard.java b/server/src/main/java/org/opensearch/index/shard/IndexShard.java
@@ -3533,7 +3533,12 @@ public void startRecovery(
                 executeRecovery("from store", recoveryState, recoveryListener, this::recoverFromStore);
                 break;
             case REMOTE_STORE:
+                // When remote indices are restored via remote metadata,
+                // the recovery source is REMOTE_STORE and unassigned Reason is CLUSTER_RECOVERED
+                // During remote index restore from local disk metadata, the unassigned Reason is still CLUSTER_RECOVERED
+                // but the RecoverySource is not REMOTE_STORE but EXISTING_STORE
                 if (shardRouting.unassignedInfo().getReason() == UnassignedInfo.Reason.CLUSTER_RECOVERED) {
+                    // At this stage the shard is in INITIALIZING state
                     logger.info("Cannot start recovery yet!");
                 } else {
                     executeRecovery("from remote store", recoveryState, recoveryListener, l -> restoreFromRemoteStore(l));