Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Convert-Index-To-Remote Action Documentation #8638

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Adding Convert-Index-To-Remote Action Documentation #8638

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f7347a2
Adding Convert-Index-To-Remote Action Documentation
kolchfa-aws Oct 30, 2024
bc549c7
Merge branch 'main' into Add-Convert-Index-To-Remote-Documentation
wntmddus Oct 30, 2024
6270641
Merge branch 'main' into Add-Convert-Index-To-Remote-Documentation
wntmddus Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions _im-plugin/ism/policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down