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

This commit is contained in:
Dan Hermann 2020-06-22 07:29:26 -05:00 committed by GitHub
parent a44dad9fbb
commit c5f5cc4cf8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 2 deletions

View File

@ -44,6 +44,10 @@ PUT /my_source_index/_settings
--------------------------------------------------
// 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]]
==== {api-description-title}

View File

@ -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
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 shrinking works
@ -79,8 +84,8 @@ A shrink operation:
. 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
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 dont work across
disks)

View File

@ -52,6 +52,10 @@ PUT /my_source_index/_settings
<1> Prevents write operations to this index while still allowing metadata
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]]
==== {api-description-title}