From e922783e38da47a3bca58061176b57be06f05c10 Mon Sep 17 00:00:00 2001 From: Tommy Shao <69884021+anntians@users.noreply.github.com> Date: Mon, 27 Jan 2025 14:45:43 -0800 Subject: [PATCH] Add UnmodifiableOnRestore property to index.knn setting (#2445) * Add UnmodifiableOnRestore property to index.knn setting Signed-off-by: AnnTian Shao * Update tests with helper methods Signed-off-by: AnnTian Shao * Update test names Signed-off-by: AnnTian Shao * Add to changeLog and fixes to tests Signed-off-by: AnnTian Shao --------- Signed-off-by: AnnTian Shao Co-authored-by: AnnTian Shao (cherry picked from commit 1d2c4c0c783428fdea7141ad069134a25b590c54) --- CHANGELOG.md | 1 + .../org/opensearch/knn/index/KNNSettings.java | 9 +- .../knn/index/RestoreSnapshotIT.java | 108 ++++++++++++++++++ .../org/opensearch/knn/KNNRestTestCase.java | 28 +++++ 4 files changed, 145 insertions(+), 1 deletion(-) create mode 100644 src/test/java/org/opensearch/knn/index/RestoreSnapshotIT.java diff --git a/CHANGELOG.md b/CHANGELOG.md index 61f94e79a6..d345c12698 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -43,6 +43,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), * Fixing it to retrieve space_type from index setting when both method and top level don't have the value. [#2374](https://github.com/opensearch-project/k-NN/pull/2374) * Fixing the bug where setting rescore as false for on_disk knn_vector query is a no-op (#2399)[https://github.com/opensearch-project/k-NN/pull/2399] * Fixing bug where mapping accepts both dimension and model-id (#2410)[https://github.com/opensearch-project/k-NN/pull/2410] +* Fixing the bug to prevent index.knn setting from being modified or removed on restore snapshot (#2445)[https://github.com/opensearch-project/k-NN/pull/2445] ### Infrastructure * Updated C++ version in JNI from c++11 to c++17 [#2259](https://github.com/opensearch-project/k-NN/pull/2259) * Upgrade bytebuddy and objenesis version to match OpenSearch core and, update github ci runner for macos [#2279](https://github.com/opensearch-project/k-NN/pull/2279) diff --git a/src/main/java/org/opensearch/knn/index/KNNSettings.java b/src/main/java/org/opensearch/knn/index/KNNSettings.java index d60b500c10..8442af764c 100644 --- a/src/main/java/org/opensearch/knn/index/KNNSettings.java +++ b/src/main/java/org/opensearch/knn/index/KNNSettings.java @@ -44,6 +44,7 @@ import static org.opensearch.common.settings.Setting.Property.IndexScope; import static org.opensearch.common.settings.Setting.Property.NodeScope; import static org.opensearch.common.settings.Setting.Property.Final; +import static org.opensearch.common.settings.Setting.Property.UnmodifiableOnRestore; import static org.opensearch.common.unit.MemorySizeValue.parseBytesSizeValueOrHeapRatio; import static org.opensearch.core.common.unit.ByteSizeValue.parseBytesSizeValue; import static org.opensearch.knn.common.featureflags.KNNFeatureFlags.getFeatureFlags; @@ -271,7 +272,13 @@ public class KNNSettings { /** * This setting identifies KNN index. */ - public static final Setting IS_KNN_INDEX_SETTING = Setting.boolSetting(KNN_INDEX, false, IndexScope, Final); + public static final Setting IS_KNN_INDEX_SETTING = Setting.boolSetting( + KNN_INDEX, + false, + IndexScope, + Final, + UnmodifiableOnRestore + ); /** * index_thread_quantity - the parameter specifies how many threads the nms library should use to create the graph. diff --git a/src/test/java/org/opensearch/knn/index/RestoreSnapshotIT.java b/src/test/java/org/opensearch/knn/index/RestoreSnapshotIT.java new file mode 100644 index 0000000000..a2c48a2210 --- /dev/null +++ b/src/test/java/org/opensearch/knn/index/RestoreSnapshotIT.java @@ -0,0 +1,108 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + */ + +package org.opensearch.knn.index; + +import org.opensearch.client.Request; +import org.opensearch.client.Response; +import org.opensearch.client.ResponseException; +import org.opensearch.common.xcontent.json.JsonXContent; +import org.opensearch.core.xcontent.XContentBuilder; +import org.opensearch.knn.KNNRestTestCase; +import org.junit.Before; +import org.junit.Test; +import lombok.SneakyThrows; +import static org.hamcrest.Matchers.containsString; + +public class RestoreSnapshotIT extends KNNRestTestCase { + + private String index = "test-index";; + private String snapshot = "snapshot-" + index; + private String repository = "repo"; + + @Before + @SneakyThrows + public void setUp() { + super.setUp(); + setupSnapshotRestore(index, snapshot, repository); + } + + @Test + @SneakyThrows + public void testKnnSettingIsModifiable_whenRestore_thenSuccess() { + // valid restore + XContentBuilder restoreCommand = JsonXContent.contentBuilder().startObject(); + restoreCommand.field("indices", index); + restoreCommand.field("rename_pattern", index); + restoreCommand.field("rename_replacement", "restored-" + index); + restoreCommand.startObject("index_settings"); + { + restoreCommand.field("knn.model.index.number_of_shards", 1); + } + restoreCommand.endObject(); + restoreCommand.endObject(); + Request restoreRequest = new Request("POST", "/_snapshot/" + repository + "/" + snapshot + "/_restore"); + restoreRequest.addParameter("wait_for_completion", "true"); + restoreRequest.setJsonEntity(restoreCommand.toString()); + + final Response restoreResponse = client().performRequest(restoreRequest); + assertEquals(200, restoreResponse.getStatusLine().getStatusCode()); + } + + @Test + @SneakyThrows + public void testKnnSettingIsUnmodifiable_whenRestore_thenFailure() { + // invalid restore + XContentBuilder restoreCommand = JsonXContent.contentBuilder().startObject(); + restoreCommand.field("indices", index); + restoreCommand.field("rename_pattern", index); + restoreCommand.field("rename_replacement", "restored-" + index); + restoreCommand.startObject("index_settings"); + { + restoreCommand.field("index.knn", false); + } + restoreCommand.endObject(); + restoreCommand.endObject(); + Request restoreRequest = new Request("POST", "/_snapshot/" + repository + "/" + snapshot + "/_restore"); + restoreRequest.addParameter("wait_for_completion", "true"); + restoreRequest.setJsonEntity(restoreCommand.toString()); + final ResponseException error = expectThrows(ResponseException.class, () -> client().performRequest(restoreRequest)); + assertThat(error.getMessage(), containsString("cannot modify UnmodifiableOnRestore setting [index.knn]" + " on restore")); + } + + @Test + @SneakyThrows + public void testKnnSettingCanBeIgnored_whenRestore_thenSuccess() { + // valid restore + XContentBuilder restoreCommand = JsonXContent.contentBuilder().startObject(); + restoreCommand.field("indices", index); + restoreCommand.field("rename_pattern", index); + restoreCommand.field("rename_replacement", "restored-" + index); + restoreCommand.field("ignore_index_settings", "knn.model.index.number_of_shards"); + restoreCommand.endObject(); + Request restoreRequest = new Request("POST", "/_snapshot/" + repository + "/" + snapshot + "/_restore"); + restoreRequest.addParameter("wait_for_completion", "true"); + restoreRequest.setJsonEntity(restoreCommand.toString()); + final Response restoreResponse = client().performRequest(restoreRequest); + assertEquals(200, restoreResponse.getStatusLine().getStatusCode()); + } + + @Test + @SneakyThrows + public void testKnnSettingCannotBeIgnored_whenRestore_thenFailure() { + // invalid restore + XContentBuilder restoreCommand = JsonXContent.contentBuilder().startObject(); + restoreCommand.field("indices", index); + restoreCommand.field("rename_pattern", index); + restoreCommand.field("rename_replacement", "restored-" + index); + restoreCommand.field("ignore_index_settings", "index.knn"); + restoreCommand.endObject(); + Request restoreRequest = new Request("POST", "/_snapshot/" + repository + "/" + snapshot + "/_restore"); + restoreRequest.addParameter("wait_for_completion", "true"); + restoreRequest.setJsonEntity(restoreCommand.toString()); + final ResponseException error = expectThrows(ResponseException.class, () -> client().performRequest(restoreRequest)); + assertThat(error.getMessage(), containsString("cannot remove UnmodifiableOnRestore setting [index.knn] on restore")); + } +} diff --git a/src/testFixtures/java/org/opensearch/knn/KNNRestTestCase.java b/src/testFixtures/java/org/opensearch/knn/KNNRestTestCase.java index 7dd1ec237d..bbc748a549 100644 --- a/src/testFixtures/java/org/opensearch/knn/KNNRestTestCase.java +++ b/src/testFixtures/java/org/opensearch/knn/KNNRestTestCase.java @@ -17,6 +17,7 @@ import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.net.URIBuilder; import org.opensearch.Version; +import org.opensearch.common.xcontent.support.XContentMapValues; import org.opensearch.core.common.bytes.BytesReference; import org.opensearch.common.xcontent.XContentHelper; import org.opensearch.core.xcontent.DeprecationHandler; @@ -73,6 +74,8 @@ import java.util.concurrent.TimeUnit; import java.util.stream.Collectors; +import static org.hamcrest.Matchers.hasSize; +import static org.hamcrest.Matchers.notNullValue; import static org.opensearch.knn.common.KNNConstants.DIMENSION; import static org.opensearch.knn.common.KNNConstants.ENCODER_PARAMETER_PQ_CODE_SIZE; import static org.opensearch.knn.common.KNNConstants.ENCODER_PARAMETER_PQ_M; @@ -1980,4 +1983,29 @@ protected boolean isApproximateThresholdSupported(final Optional bwcVers protected static String randomLowerCaseString() { return randomAlphaOfLengthBetween(MIN_CODE_UNITS, MAX_CODE_UNITS).toLowerCase(Locale.ROOT); } + + @SneakyThrows + protected void setupSnapshotRestore(String index, String snapshot, String repository) { + Request clusterSettingsRequest = new Request("GET", "/_cluster/settings"); + clusterSettingsRequest.addParameter("include_defaults", "true"); + Response clusterSettingsResponse = client().performRequest(clusterSettingsRequest); + Map clusterSettings = entityAsMap(clusterSettingsResponse); + + @SuppressWarnings("unchecked") + List pathRepos = (List) XContentMapValues.extractValue("defaults.path.repo", clusterSettings); + assertThat(pathRepos, notNullValue()); + assertThat(pathRepos, hasSize(1)); + + final String pathRepo = pathRepos.get(0); + + // create index + createIndex(index, getDefaultIndexSettings()); + + // create repo + Settings repoSettings = Settings.builder().put("compress", randomBoolean()).put("location", pathRepo).build(); + registerRepository(repository, "fs", true, repoSettings); + + // create snapshot + createSnapshot(repository, snapshot, true); + } }