From f7347a2d9c8e3d2fe66a648b78fd0b3a6ed4ef82 Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Wed, 30 Oct 2024 16:46:56 -0400 Subject: [PATCH] Adding Convert-Index-To-Remote Action Documentation Signed-off-by: Seung Yeon Joo --- _im-plugin/ism/policies.md | 28 ++++++++++++++++++++++++++ _ingest-pipelines/processors/append.md | 1 + 2 files changed, 29 insertions(+) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 27c37e67ea..5c5ed1ff40 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -108,6 +108,7 @@ ISM supports the following operations: - [rollover](#rollover) - [notification](#notification) - [snapshot](#snapshot) +- [convert-index-to-remote](#convert_index_to_remote) - [index_priority](#index_priority) - [allocation](#allocation) - [rollup](#rollup) @@ -406,6 +407,33 @@ Parameter | Description | Type | Required | Default } ``` +### convert_index_to_remote + +Restore a cluster's index saved as a snapshot into a remote index. + +The convert_index_to_remote operation allows you to convert and restore an index from a local snapshot repository to a remote repository. + +The `convert_index_to_remote' operation has the following parameters: + +Parameter | Description | Type | Required | Default +:--- | :--- |:--- |:--- | +`repository` | The repository name that you register through the native snapshot API operations. | `string` | Yes | - + +```json +{ + "snapshot": { + "repository": "my_backup", + "snapshot": "{{ctx.index}}" + }, + "convert_index_to_remote": { + "repository": "my_backup" + } +} +``` + +Ensure that the repository name used in the convert_index_to_remote operation matches the repository name specified during the snapshot action. Additionally, reference the snapshot using {{ctx.index}}. + + ### index_priority Set the priority for the index in a specific state. Unallocated shards of indexes are recovered in the order of their priority, whenever possible. The indexes with higher priority values are recovered first followed by the indexes with lower priority values. diff --git a/_ingest-pipelines/processors/append.md b/_ingest-pipelines/processors/append.md index 8101cf97c9..fe222e647f 100644 --- a/_ingest-pipelines/processors/append.md +++ b/_ingest-pipelines/processors/append.md @@ -43,6 +43,7 @@ Parameter | Required/Optional | Description | `description` | Optional | A brief description of the processor. | `if` | Optional | A condition for running the processor. | `ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters errors. If set to `true`, failures are ignored. Default is `false`. | +`allow_duplicates` | Optional | Specifies whether to append the values already contained in the field. If `true`, duplicate values are appended. Otherwise, they are skipped. | `on_failure` | Optional | A list of processors to run if the processor fails. | `tag` | Optional | An identifier tag for the processor. Useful for debugging in order to distinguish between processors of the same type. |