From d3548e347a29acd1abcbdd598d9e7cdaf0d05efa Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Fri, 14 Jul 2023 13:05:01 -0700 Subject: [PATCH 01/13] addedinfoaboutcodecs Signed-off-by: Heather Halter --- .../snapshots/snapshot-restore.md | 30 +++++++++++-------- 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 2a79e7adbc..db3df1fb3c 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -209,14 +209,14 @@ You specify two pieces of information when you create a snapshot: - Name of your snapshot repository - Name for the snapshot -The following snapshot includes all indices and the cluster state: +The following snapshot includes all indexes and the cluster state: ```json PUT /_snapshot/my-repository/1 ``` {% include copy-curl.html %} -You can also add a request body to include or exclude certain indices or specify other settings: +You can also add a request body to include or exclude certain indexes or specify other settings: ```json PUT /_snapshot/my-repository/2 @@ -231,7 +231,7 @@ PUT /_snapshot/my-repository/2 Request fields | Description :--- | :--- -`indices` | The indices you want to include in the snapshot. You can use `,` to create a list of indices, `*` to specify an index pattern, and `-` to exclude certain indices. Don't put spaces between items. Default is all indices. +`indices` | The indexes you want to include in the snapshot. You can use `,` to create a list of indexes, `*` to specify an index pattern, and `-` to exclude certain indexes. Don't put spaces between items. Default is all indexes. `ignore_unavailable` | If an index from the `indices` list doesn't exist, whether to ignore it rather than fail the snapshot. Default is false. `include_global_state` | Whether to include cluster state in the snapshot. Default is true. `partial` | Whether to allow partial snapshots. Default is false, which fails the entire snapshot if one or more shards fails to store. @@ -306,7 +306,7 @@ POST /_snapshot/my-repository/2/_restore ``` {% include copy-curl.html %} -Just like when taking a snapshot, you can add a request body to include or exclude certain indices or specify some other settings: +Just like when taking a snapshot, you can add a request body to include or exclude certain indexes or specify some other settings: ```json POST /_snapshot/my-repository/2/_restore @@ -330,22 +330,22 @@ POST /_snapshot/my-repository/2/_restore Request parameters | Description :--- | :--- -`indices` | The indices you want to restore. You can use `,` to create a list of indices, `*` to specify an index pattern, and `-` to exclude certain indices. Don't put spaces between items. Default is all indices. +`indices` | The indexes you want to restore. You can use `,` to create a list of indexes, `*` to specify an index pattern, and `-` to exclude certain indexes. Don't put spaces between items. Default is all indexes. `ignore_unavailable` | If an index from the `indices` list doesn't exist, whether to ignore it rather than fail the restore operation. Default is false. `include_global_state` | Whether to restore the cluster state. Default is false. -`include_aliases` | Whether to restore aliases alongside their associated indices. Default is true. +`include_aliases` | Whether to restore aliases alongside their associated indexes. Default is true. `partial` | Whether to allow the restoration of partial snapshots. Default is false. -`rename_pattern` | If you want to rename indices as you restore them, use this option to specify a regular expression that matches all indices you want to restore. Use capture groups (`()`) to reuse portions of the index name. -`rename_replacement` | If you want to rename indices as you restore them, use this option to specify the replacement pattern. Use `$0` to include the entire matching index name, `$1` to include the content of the first capture group, etc. +`rename_pattern` | If you want to rename indexes as you restore them, use this option to specify a regular expression that matches all indexes you want to restore. Use capture groups (`()`) to reuse portions of the index name. +`rename_replacement` | If you want to rename indexes as you restore them, use this option to specify the replacement pattern. Use `$0` to include the entire matching index name, `$1` to include the content of the first capture group, etc. `index_settings` | If you want to change [index settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#index-settings) applied during restore, specify them here. You cannot change `index.number_of_shards`. `ignore_index_settings` | Rather than explicitly specifying new settings with `index_settings`, you can ignore certain index settings in the snapshot and use the cluster defaults applied during restore. You cannot ignore `index.number_of_shards`, `index.number_of_replicas`, or `index.auto_expand_replicas`. `storage_type` | `local` indicates that all snapshot metadata and index data will be downloaded to local storage.

`remote_snapshot` indicates that snapshot metadata will be downloaded to the cluster, but the remote repository will remain the authoritative store of the index data. Data will be downloaded and cached as necessary to service queries. At least one node in the cluster must be configured with the [search role]({{site.url}}{{site.baseurl}}/security/access-control/users-roles/) in order to restore a snapshot using the type `remote_snapshot`.

Defaults to `local`. ### Conflicts and compatibility -One way to avoid naming conflicts when restoring indices is to use the `rename_pattern` and `rename_replacement` options. Then, if necessary, you can use the `_reindex` API to combine the two. The simpler way is to delete existing indices prior to restoring from a snapshot. +One way to avoid naming conflicts when restoring indexes is to use the `rename_pattern` and `rename_replacement` options. You can then, if necessary, use the `_reindex` API to combine the two. The simpler way is to delete existing indexes prior to restoring from a snapshot. -You can use the `_close` API to close existing indices prior to restoring from a snapshot, but the index in the snapshot has to have the same number of shards as the existing index. +You can use the `_close` API to close existing indexes prior to restoring from a snapshot, but the index in the snapshot has to have the same number of shards as the existing index. We recommend ceasing write requests to a cluster before restoring from a snapshot, which helps avoid scenarios such as: @@ -353,7 +353,13 @@ We recommend ceasing write requests to a cluster before restoring from a snapsho 1. A write request to the now-deleted alias creates a new index with the same name as the alias. 1. The alias from the snapshot fails to restore due to a naming conflict with the new index. -Snapshots are only forward-compatible by one major version. If you have an old snapshot, you can sometimes restore it into an intermediate cluster, reindex all indices, take a new snapshot, and repeat until you arrive at your desired version, but you might find it easier to just manually index your data on the new cluster. +Snapshots are only forward-compatible by one major version. If you have an old snapshot, you can sometimes restore it into an intermediate cluster, reindex all indexes, take a new snapshot, and repeat until you arrive at your desired version, but you might find it easier to just manually index your data on the new cluster. + +When creating a snapshot, the index codec setting influences both the size of the snapshot and the time required for its creation. If the codec of an index is updated, new snapshots created will utilize the latest codec setting. The resulting snapshot size will reflect the compression characteristics of the latest codec settings. Existing segments included in the snapshot retain their original compression characteristics. + +If you want to restore the indexes from a snapshot of a cluster to another cluster, then it is important to verify that the target cluster supports the codecs of the segments present in the source snapshot. For example, if the source snapshot has the segments of `zstd` or `zstd_no_dict` codecs (introduced in OpenSearch 2.9), then the user cannot restore to the target cluster where the support of these codecs is not available. + +For more information about index codec settings, see [Index codec settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/Index-codec-settings/)) ## Security considerations @@ -362,7 +368,7 @@ If you're using the Security plugin, snapshots have some additional restrictions - To perform snapshot and restore operations, users must have the built-in `manage_snapshots` role. - You can't restore snapshots that contain global state or the `.opendistro_security` index. -If a snapshot contains global state, you must exclude it when performing the restore. If your snapshot also contains the `.opendistro_security` index, either exclude it or list all the other indices you want to include: +If a snapshot contains global state, you must exclude it when performing the restore. If your snapshot also contains the `.opendistro_security` index, either exclude it or list all the other indexes you want to include: ```json POST /_snapshot/my-repository/3/_restore From b9d62437a31b7e9f04aa051f048d58b8afb6873b Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Fri, 14 Jul 2023 13:38:43 -0700 Subject: [PATCH 02/13] added collapsible toc Signed-off-by: Heather Halter --- .../snapshots/snapshot-restore.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index db3df1fb3c..78068aa477 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -24,14 +24,17 @@ If you need to delete a snapshot, be sure to use the OpenSearch API rather than --- -#### Table of contents -1. TOC +
+ + Table of contents + + {: .text-delta } +- TOC {:toc} - +
--- - ## Register repository Before you can take a snapshot, you have to "register" a snapshot repository. A snapshot repository is just a storage location: a shared file system, Amazon S3, Hadoop Distributed File System (HDFS), Azure Storage, etc. @@ -359,7 +362,7 @@ When creating a snapshot, the index codec setting influences both the size of th If you want to restore the indexes from a snapshot of a cluster to another cluster, then it is important to verify that the target cluster supports the codecs of the segments present in the source snapshot. For example, if the source snapshot has the segments of `zstd` or `zstd_no_dict` codecs (introduced in OpenSearch 2.9), then the user cannot restore to the target cluster where the support of these codecs is not available. -For more information about index codec settings, see [Index codec settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/Index-codec-settings/)) +For more information about index codec settings, see [Index codec settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#Index-codec-settings/). ## Security considerations From 14c8d12a00526ac19d6e769aee42f2bbc5c48865 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Sat, 15 Jul 2023 11:16:06 -0700 Subject: [PATCH 03/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 78068aa477..3040e8fa2b 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -360,7 +360,7 @@ Snapshots are only forward-compatible by one major version. If you have an old s When creating a snapshot, the index codec setting influences both the size of the snapshot and the time required for its creation. If the codec of an index is updated, new snapshots created will utilize the latest codec setting. The resulting snapshot size will reflect the compression characteristics of the latest codec settings. Existing segments included in the snapshot retain their original compression characteristics. -If you want to restore the indexes from a snapshot of a cluster to another cluster, then it is important to verify that the target cluster supports the codecs of the segments present in the source snapshot. For example, if the source snapshot has the segments of `zstd` or `zstd_no_dict` codecs (introduced in OpenSearch 2.9), then the user cannot restore to the target cluster where the support of these codecs is not available. +If you want to restore the indexes from a snapshot of a cluster to another cluster, it is important to verify that the target cluster supports the codecs used for the segments present in the source snapshot. For example, if the source snapshot uses the `zstd_no_dict` codec with its segments (introduced in OpenSearch 2.9), the user cannot restore to the target cluster unless the target cluster supports this codec. For more information about index codec settings, see [Index codec settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#Index-codec-settings/). From fb29636796566f6d2228742a106d50a78d14e391 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 09:53:56 -0700 Subject: [PATCH 04/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 3040e8fa2b..de9a6f004b 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -339,7 +339,7 @@ Request parameters | Description `include_aliases` | Whether to restore aliases alongside their associated indexes. Default is true. `partial` | Whether to allow the restoration of partial snapshots. Default is false. `rename_pattern` | If you want to rename indexes as you restore them, use this option to specify a regular expression that matches all indexes you want to restore. Use capture groups (`()`) to reuse portions of the index name. -`rename_replacement` | If you want to rename indexes as you restore them, use this option to specify the replacement pattern. Use `$0` to include the entire matching index name, `$1` to include the content of the first capture group, etc. +`rename_replacement` | If you want to rename indexes as you restore them, use this option to specify the replacement pattern. Use `$0` to include the entire matching index name, `$1` to include the content of the first capture group, and so on. `index_settings` | If you want to change [index settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#index-settings) applied during restore, specify them here. You cannot change `index.number_of_shards`. `ignore_index_settings` | Rather than explicitly specifying new settings with `index_settings`, you can ignore certain index settings in the snapshot and use the cluster defaults applied during restore. You cannot ignore `index.number_of_shards`, `index.number_of_replicas`, or `index.auto_expand_replicas`. `storage_type` | `local` indicates that all snapshot metadata and index data will be downloaded to local storage.

`remote_snapshot` indicates that snapshot metadata will be downloaded to the cluster, but the remote repository will remain the authoritative store of the index data. Data will be downloaded and cached as necessary to service queries. At least one node in the cluster must be configured with the [search role]({{site.url}}{{site.baseurl}}/security/access-control/users-roles/) in order to restore a snapshot using the type `remote_snapshot`.

Defaults to `local`. From 68aa8dd1501c8036314119fb6141a536b35b2d07 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 09:54:42 -0700 Subject: [PATCH 05/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index de9a6f004b..340a948fdb 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -356,7 +356,7 @@ We recommend ceasing write requests to a cluster before restoring from a snapsho 1. A write request to the now-deleted alias creates a new index with the same name as the alias. 1. The alias from the snapshot fails to restore due to a naming conflict with the new index. -Snapshots are only forward-compatible by one major version. If you have an old snapshot, you can sometimes restore it into an intermediate cluster, reindex all indexes, take a new snapshot, and repeat until you arrive at your desired version, but you might find it easier to just manually index your data on the new cluster. +Snapshots are only forward-compatible by one major version. If you have an old snapshot, you can sometimes restore it into an intermediate cluster, reindex all indexes, take a new snapshot, and repeat until you arrive at your desired version, but you might find it easier to just manually index your data in the new cluster. When creating a snapshot, the index codec setting influences both the size of the snapshot and the time required for its creation. If the codec of an index is updated, new snapshots created will utilize the latest codec setting. The resulting snapshot size will reflect the compression characteristics of the latest codec settings. Existing segments included in the snapshot retain their original compression characteristics. From de9a5d3939ff1c612c41c02d95d52f11edb53a62 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 09:54:57 -0700 Subject: [PATCH 06/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 340a948fdb..ea8fb606e2 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -358,7 +358,7 @@ We recommend ceasing write requests to a cluster before restoring from a snapsho Snapshots are only forward-compatible by one major version. If you have an old snapshot, you can sometimes restore it into an intermediate cluster, reindex all indexes, take a new snapshot, and repeat until you arrive at your desired version, but you might find it easier to just manually index your data in the new cluster. -When creating a snapshot, the index codec setting influences both the size of the snapshot and the time required for its creation. If the codec of an index is updated, new snapshots created will utilize the latest codec setting. The resulting snapshot size will reflect the compression characteristics of the latest codec settings. Existing segments included in the snapshot retain their original compression characteristics. +When creating a snapshot, the index codec setting influences both the size of the snapshot and the time required for its creation. If an index codec is updated, newly created snapshots will use the latest codec setting. The resulting snapshot size will reflect the compression characteristics of the latest codec settings. Existing segments included in the snapshot retain their original compression characteristics. If you want to restore the indexes from a snapshot of a cluster to another cluster, it is important to verify that the target cluster supports the codecs used for the segments present in the source snapshot. For example, if the source snapshot uses the `zstd_no_dict` codec with its segments (introduced in OpenSearch 2.9), the user cannot restore to the target cluster unless the target cluster supports this codec. From 813d978f2c020d8526e4f35a9ad211065adc6fc7 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 09:55:10 -0700 Subject: [PATCH 07/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index ea8fb606e2..4fd6e54d78 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -360,7 +360,7 @@ Snapshots are only forward-compatible by one major version. If you have an old s When creating a snapshot, the index codec setting influences both the size of the snapshot and the time required for its creation. If an index codec is updated, newly created snapshots will use the latest codec setting. The resulting snapshot size will reflect the compression characteristics of the latest codec settings. Existing segments included in the snapshot retain their original compression characteristics. -If you want to restore the indexes from a snapshot of a cluster to another cluster, it is important to verify that the target cluster supports the codecs used for the segments present in the source snapshot. For example, if the source snapshot uses the `zstd_no_dict` codec with its segments (introduced in OpenSearch 2.9), the user cannot restore to the target cluster unless the target cluster supports this codec. +If you want to restore the indexes from a snapshot of a cluster to another cluster, it is important to verify that the target cluster supports the codecs used for the segments present in the source snapshot. For example, if the source snapshot uses the `zstd_no_dict` codec for its segments (introduced in OpenSearch 2.9), the user cannot restore to the target cluster unless the target cluster supports this codec. For more information about index codec settings, see [Index codec settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#Index-codec-settings/). From 4a09892daa90d6deb756f39b0e6830f37992cfc6 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 09:55:23 -0700 Subject: [PATCH 08/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 4fd6e54d78..a564dc6f74 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -371,7 +371,7 @@ If you're using the Security plugin, snapshots have some additional restrictions - To perform snapshot and restore operations, users must have the built-in `manage_snapshots` role. - You can't restore snapshots that contain global state or the `.opendistro_security` index. -If a snapshot contains global state, you must exclude it when performing the restore. If your snapshot also contains the `.opendistro_security` index, either exclude it or list all the other indexes you want to include: +If a snapshot contains a global state, you must exclude it when performing the restore. If your snapshot also contains the `.opendistro_security` index, either exclude it or list all the other indexes you want to include: ```json POST /_snapshot/my-repository/3/_restore From e3b8c884f9b8cf54e4db7daa2d688328523b9ed9 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 09:55:33 -0700 Subject: [PATCH 09/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index a564dc6f74..69ef3bd1b3 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -369,7 +369,7 @@ For more information about index codec settings, see [Index codec settings]({{si If you're using the Security plugin, snapshots have some additional restrictions: - To perform snapshot and restore operations, users must have the built-in `manage_snapshots` role. -- You can't restore snapshots that contain global state or the `.opendistro_security` index. +- You can't restore snapshots that contain a global state or the `.opendistro_security` index. If a snapshot contains a global state, you must exclude it when performing the restore. If your snapshot also contains the `.opendistro_security` index, either exclude it or list all the other indexes you want to include: From 2180da3c624840212ed7be4fba7959c7f3887233 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 10:02:08 -0700 Subject: [PATCH 10/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 69ef3bd1b3..9018e0baf6 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -236,7 +236,7 @@ Request fields | Description :--- | :--- `indices` | The indexes you want to include in the snapshot. You can use `,` to create a list of indexes, `*` to specify an index pattern, and `-` to exclude certain indexes. Don't put spaces between items. Default is all indexes. `ignore_unavailable` | If an index from the `indices` list doesn't exist, whether to ignore it rather than fail the snapshot. Default is false. -`include_global_state` | Whether to include cluster state in the snapshot. Default is true. +`include_global_state` | Whether to include cluster state in the snapshot. Default is `true`. `partial` | Whether to allow partial snapshots. Default is false, which fails the entire snapshot if one or more shards fails to store. If you request the snapshot immediately after taking it, you might see something like this: From 56523bfa301ce938558e11ad2af491d643850470 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 10:02:16 -0700 Subject: [PATCH 11/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 9018e0baf6..3b229b104a 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -237,7 +237,7 @@ Request fields | Description `indices` | The indexes you want to include in the snapshot. You can use `,` to create a list of indexes, `*` to specify an index pattern, and `-` to exclude certain indexes. Don't put spaces between items. Default is all indexes. `ignore_unavailable` | If an index from the `indices` list doesn't exist, whether to ignore it rather than fail the snapshot. Default is false. `include_global_state` | Whether to include cluster state in the snapshot. Default is `true`. -`partial` | Whether to allow partial snapshots. Default is false, which fails the entire snapshot if one or more shards fails to store. +`partial` | Whether to allow partial snapshots. Default is `false`, which fails the entire snapshot if one or more shards fails to store. If you request the snapshot immediately after taking it, you might see something like this: From 7962ff52596a8122467e65f0a51a040e41bceb71 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 17 Jul 2023 10:02:31 -0700 Subject: [PATCH 12/13] Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 3b229b104a..26f34d5791 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -235,7 +235,7 @@ PUT /_snapshot/my-repository/2 Request fields | Description :--- | :--- `indices` | The indexes you want to include in the snapshot. You can use `,` to create a list of indexes, `*` to specify an index pattern, and `-` to exclude certain indexes. Don't put spaces between items. Default is all indexes. -`ignore_unavailable` | If an index from the `indices` list doesn't exist, whether to ignore it rather than fail the snapshot. Default is false. +`ignore_unavailable` | If an index from the `indices` list doesn't exist, whether to ignore it rather than fail the snapshot. Default is `false`. `include_global_state` | Whether to include cluster state in the snapshot. Default is `true`. `partial` | Whether to allow partial snapshots. Default is `false`, which fails the entire snapshot if one or more shards fails to store. From 1ad957ecf49d64d846723e68ae02b3dc8bdf424f Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Thu, 20 Jul 2023 08:59:37 -0700 Subject: [PATCH 13/13] Update snapshot-restore.md Removed information about codecs in favor of a separate PR Signed-off-by: Heather Halter --- .../availability-and-recovery/snapshots/snapshot-restore.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index 26f34d5791..e68d70b9c5 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -358,12 +358,6 @@ We recommend ceasing write requests to a cluster before restoring from a snapsho Snapshots are only forward-compatible by one major version. If you have an old snapshot, you can sometimes restore it into an intermediate cluster, reindex all indexes, take a new snapshot, and repeat until you arrive at your desired version, but you might find it easier to just manually index your data in the new cluster. -When creating a snapshot, the index codec setting influences both the size of the snapshot and the time required for its creation. If an index codec is updated, newly created snapshots will use the latest codec setting. The resulting snapshot size will reflect the compression characteristics of the latest codec settings. Existing segments included in the snapshot retain their original compression characteristics. - -If you want to restore the indexes from a snapshot of a cluster to another cluster, it is important to verify that the target cluster supports the codecs used for the segments present in the source snapshot. For example, if the source snapshot uses the `zstd_no_dict` codec for its segments (introduced in OpenSearch 2.9), the user cannot restore to the target cluster unless the target cluster supports this codec. - -For more information about index codec settings, see [Index codec settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#Index-codec-settings/). - ## Security considerations If you're using the Security plugin, snapshots have some additional restrictions: