Skip to content

Fix operation "convert_index_to_remote" bug . Rmote index name using the remote_ prefix instead of _remote suffix w… #1427

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix operation "convert_index_to_remote" bug . Rmote index name using the remote_ prefix instead of _remote suffix w… #1427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion ...in/org/opensearch/indexmanagement/indexstatemanagement/step/restore/AttemptRestoreStep.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class AttemptRestoreStep(private val action: ConvertIndexToRemoteAction) : Step(
.indices(indexName)
.storageType(RestoreSnapshotRequest.StorageType.REMOTE_SNAPSHOT)
.renamePattern("^(.*)\$")
.renameReplacement("$1_remote")
.renameReplacement("remote_$1")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looked at your issue. While I agree that restore action can lead to a policy starting off again but changing the index name may not be a full proof solution since there can be existing policies defined on pattern like remote_*

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably need a solution like this where during policy validation itself user defines a pattern to be appended to a restored index and probably during policy definition itself a exclude pattern template is set.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.Even if we use this solution, I think we cannot fully avoid conflicts. We may still have local indexes with names matching pattern "abc* _demote*", so this template could affect local indexes like "abc*_demote*".
The solution of changing the remote suffix to the remote prefix is to solve the conflicts that always occur, and then we can enhanced and optimized the settings continue.

2.During define policy, set a exclude index pattern. I agree that this solution can resolve this issue fully, because the match index is the difference-set of index-pattern and exclude-index-pattern ,and it will not affect other indexes.

3.before "convert_index_to_remote" operation implemented and published, we implemented a solution internal named "searchable_snapshot", that use most origin settings of snapshots-restore,
so it's more flexible ,users can use rename_replacement setting to set the new index name, and can proactively avoid conflicts. If most thinks it's possible to add settings like "rename_deplacement" , I can also submit this implement code.

      {
        "name": "searchablesnapshot",
        "actions": [
          {
            "searchable_snapshot": {
              "repository": "my_s3_repository",
              "snapshot": "ss_{{ctx.index}}",
              "rename_pattern": "(.+)",
              "rename_replacement": "remote_$1",
              "index_settings": {
                "index.number_of_replicas": 0
              },
              "rename_alias_pattern":"(.+)",
              "rename_alias_replacement":"remote_$1"
            }
          }
        ],
        "transitions": [
          {
            "state_name": "delete"
          }
        ]
      }

4.Please provide as many ideas and advice as possible and have a discussions, I will implement the solution which most approve.

.waitForCompletion(false)
val response: RestoreSnapshotResponse = context.client.admin().cluster().suspendUntil {
restoreSnapshot(restoreSnapshotRequest, it)
Expand Down
2 changes: 1 addition & 1 deletion ...rg/opensearch/indexmanagement/indexstatemanagement/action/ConvertIndexToRemoteActionIT.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ class ConvertIndexToRemoteActionIT : IndexStateManagementRestTestCase() {
)
}

val remoteIndexName = "${indexName}_remote"
val remoteIndexName = "remote_$indexName"
waitFor { assertIndexExists(remoteIndexName) }

val isRemote = isIndexRemote(remoteIndexName)
Expand Down