Browse Source

[DOCS] Clone index API doesn't copy index metadata (#73787)

Notes that the clone index API doesn't copy index metadata and highlights some affected features.

Closes #69490
James Rodewig 4 years ago
parent
commit
3fbc182076
1 changed files with 7 additions and 4 deletions
  1. 7 4
      docs/reference/indices/clone-index.asciidoc

+ 7 - 4
docs/reference/indices/clone-index.asciidoc

@@ -53,10 +53,13 @@ and then the previous write index can be cloned.
 [[clone-index-api-desc]]
 ==== {api-description-title}
 
-Use the clone index API
-to clone an existing index into a new index,
-where each original primary shard is cloned
-into a new primary shard in the new index.
+Use the clone index API to clone an existing index into a new index, where each
+original primary shard is cloned into a new primary shard in the new index.
+
+IMPORTANT: Cloning doesn't copy index metadata. This metadata includes aliases,
+{ilm-init} phase definitions, and {ccr-init} follower information. For example,
+if you clone a {ccr-init} follower index, the resulting clone won't be a
+follower index.
 
 [[cloning-works]]
 ===== How cloning works