Browse Source

[DOCS] Prohibit cloning, splitting, and shrinking a data stream's write index (#58105)

Dan Hermann 5 years ago
parent
commit
484918ca70

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

@@ -44,6 +44,10 @@ PUT /my_source_index/_settings
 --------------------------------------------------
 --------------------------------------------------
 // TEST[s/^/PUT my_source_index\n/]
 // TEST[s/^/PUT my_source_index\n/]
 
 
+The current write index on a data stream cannot be cloned. In order to clone
+the current write index, the data stream must first be
+<<rollover-data-stream-ex,rolled over>> so that a new write index is created
+and then the previous write index can be cloned.
 
 
 [[clone-index-api-desc]]
 [[clone-index-api-desc]]
 ==== {api-description-title}
 ==== {api-description-title}

+ 7 - 2
docs/reference/indices/shrink-index.asciidoc

@@ -69,6 +69,11 @@ of shards in the index is a prime number it can only be shrunk into a single
 primary shard. Before shrinking, a (primary or replica) copy of every shard
 primary shard. Before shrinking, a (primary or replica) copy of every shard
 in the index must be present on the same node.
 in the index must be present on the same node.
 
 
+The current write index on a data stream cannot be shrunk. In order to shrink
+the current write index, the data stream must first be
+<<rollover-data-stream-ex,rolled over>> so that a new write index is created
+and then the previous write index can be shrunk.
+
 [[how-shrink-works]]
 [[how-shrink-works]]
 ===== How shrinking works
 ===== How shrinking works
 
 
@@ -79,8 +84,8 @@ A shrink operation:
 
 
 . Hard-links segments from the source index into the target index. (If
 . Hard-links segments from the source index into the target index. (If
   the file system doesn't support hard-linking, then all segments are copied
   the file system doesn't support hard-linking, then all segments are copied
-  into the new index, which is a much more time consuming process. Also if using 
-  multiple data paths, shards on different data paths require a full copy of 
+  into the new index, which is a much more time consuming process. Also if using
+  multiple data paths, shards on different data paths require a full copy of
   segment files if they are not on the same disk since hardlinks don’t work across
   segment files if they are not on the same disk since hardlinks don’t work across
   disks)
   disks)
 
 

+ 4 - 0
docs/reference/indices/split-index.asciidoc

@@ -52,6 +52,10 @@ PUT /my_source_index/_settings
 <1> Prevents write operations to this index while still allowing metadata
 <1> Prevents write operations to this index while still allowing metadata
     changes like deleting the index.
     changes like deleting the index.
 
 
+The current write index on a data stream cannot be split. In order to split
+the current write index, the data stream must first be
+<<rollover-data-stream-ex,rolled over>> so that a new write index is created
+and then the previous write index can be split.
 
 
 [[split-index-api-desc]]
 [[split-index-api-desc]]
 ==== {api-description-title}
 ==== {api-description-title}