[SnapshotV2] Support centralize snapshot creation

server/src/internalClusterTest/java/org/opensearch/remotestore/RemoteRestoreSnapshotIT.java

@@ -46,6 +46,7 @@
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -746,4 +747,58 @@ public void testInvalidRestoreRequestScenarios() throws Exception {
         assertTrue(exception.getMessage().contains("cannot remove setting [index.remote_store.segment.repository]" + " on restore"));
     }
 
+    public void testCreateShallowCopyV2() throws Exception {
+
+        Settings snapshotSettings = Settings.builder().put("snapshot.shallow_snapshot_v2", true).build();
+        internalCluster().startClusterManagerOnlyNode(Settings.builder().put(snapshotSettings).build());
+        internalCluster().startDataOnlyNode(Settings.builder().put(snapshotSettings).build());
+        String indexName1 = "testindex1";
+        String indexName2 = "testindex2";
+        String snapshotRepoName = "test-create-snapshot-repo";
+        String snapshotName1 = "test-create-snapshot1";
+        Path absolutePath1 = randomRepoPath().toAbsolutePath();
+        logger.info("Snapshot Path [{}]", absolutePath1);
+        String restoredIndexName1 = indexName1 + "-restored";
+
+        createRepository(snapshotRepoName, "fs", getRepositorySettings(absolutePath1, true));
+
+        Client client = client();
+        Settings indexSettings = getIndexSettings(20, 0).build();
+        createIndex(indexName1, indexSettings);
+
+        Settings indexSettings2 = getIndexSettings(15, 0).build();
+        createIndex(indexName2, indexSettings2);
+
+        final int numDocsInIndex1 = 10;
+        final int numDocsInIndex2 = 20;
+        indexDocuments(client, indexName1, numDocsInIndex1);
+        indexDocuments(client, indexName2, numDocsInIndex2);
+        ensureGreen(indexName1, indexName2);
+
+        internalCluster().startDataOnlyNode(Settings.builder().put(snapshotSettings).build());
+        logger.info("--> snapshot");
+
+        SnapshotInfo snapshotInfo = createSnapshot(snapshotRepoName, snapshotName1, Collections.emptyList());
+        assertThat(snapshotInfo.state(), equalTo(SnapshotState.SUCCESS));
+        assertThat(snapshotInfo.successfulShards(), greaterThan(0));
+        assertThat(snapshotInfo.successfulShards(), equalTo(snapshotInfo.totalShards()));
+
+        // // delete indices
+        // DeleteResponse deleteResponse = client().prepareDelete(indexName1, "0").execute().actionGet();
+        // assertEquals(deleteResponse.getResult(), DocWriteResponse.Result.DELETED);
+        // RestoreSnapshotResponse restoreSnapshotResponse1 = client.admin()
+        // .cluster()
+        // .prepareRestoreSnapshot(snapshotRepoName, snapshotName1)
+        // .setWaitForCompletion(false)
+        // .setIndices(indexName1)
+        // .setRenamePattern(indexName1)
+        // .setRenameReplacement(restoredIndexName1)
+        // .get();
+        //
+        // assertEquals(restoreSnapshotResponse1.status(), RestStatus.ACCEPTED);
+        // ensureYellowAndNoInitializingShards(restoredIndexName1);
+        // ensureGreen(restoredIndexName1);
+        // assertDocsPresentInIndex(client(), restoredIndexName1, numDocsInIndex1);
+    }
+
 }

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/create/TransportCreateSnapshotAction.java

@@ -106,7 +106,7 @@ protected void clusterManagerOperation(
         if (request.waitForCompletion()) {
             snapshotsService.executeSnapshot(request, ActionListener.map(listener, CreateSnapshotResponse::new));
         } else {
-            snapshotsService.createSnapshot(request, ActionListener.map(listener, snapshot -> new CreateSnapshotResponse()));
+            snapshotsService.startCreateSnapshot(request, ActionListener.map(listener, snapshot -> new CreateSnapshotResponse()));
         }
     }
 }

server/src/main/java/org/opensearch/common/settings/ClusterSettings.java

@@ -632,6 +632,7 @@ public void apply(Settings value, Settings current, Settings previous) {
                 HandshakingTransportAddressConnector.PROBE_CONNECT_TIMEOUT_SETTING,
                 HandshakingTransportAddressConnector.PROBE_HANDSHAKE_TIMEOUT_SETTING,
                 SnapshotsService.MAX_CONCURRENT_SNAPSHOT_OPERATIONS_SETTING,
+                SnapshotsService.SHALLOW_SNAPSHOT_V2,
                 FsHealthService.ENABLED_SETTING,
                 FsHealthService.REFRESH_INTERVAL_SETTING,
                 FsHealthService.SLOW_PATH_LOGGING_THRESHOLD_SETTING,

server/src/main/java/org/opensearch/snapshots/SnapshotInfo.java

@@ -98,10 +98,14 @@ public final class SnapshotInfo implements Comparable<SnapshotInfo>, ToXContent,
     private static final String INCLUDE_GLOBAL_STATE = "include_global_state";
 
     private static final String REMOTE_STORE_INDEX_SHALLOW_COPY = "remote_store_index_shallow_copy";
+
+    private static final String PINNED_TIMESTAMP = "pinned_timestamp";
     private static final String USER_METADATA = "metadata";
 
     private static final Comparator<SnapshotInfo> COMPARATOR = Comparator.comparing(SnapshotInfo::startTime)
         .thenComparing(SnapshotInfo::snapshotId);
+    private XContentBuilder builder;
+    private XContentBuilder build;
 
     /**
      * Builds snapshot information
@@ -121,6 +125,7 @@ public static final class SnapshotInfoBuilder {
         private Boolean includeGlobalState = null;
 
         private Boolean remoteStoreIndexShallowCopy = null;
+        private long pinnedTimestamp = 0L;
         private Map<String, Object> userMetadata = null;
         private int version = -1;
         private List<SnapshotShardFailure> shardFailures = null;
@@ -177,6 +182,10 @@ private void setRemoteStoreIndexShallowCopy(Boolean remoteStoreIndexShallowCopy)
             this.remoteStoreIndexShallowCopy = remoteStoreIndexShallowCopy;
         }
 
+        private void setPinnedTimestamp(long pinnedTimestamp) {
+            this.pinnedTimestamp = pinnedTimestamp;
+        }
+
         private void setShardFailures(List<SnapshotShardFailure> shardFailures) {
             this.shardFailures = shardFailures;
         }
@@ -216,7 +225,8 @@ public SnapshotInfo build() {
                 shardFailures,
                 includeGlobalState,
                 userMetadata,
-                remoteStoreIndexShallowCopy
+                remoteStoreIndexShallowCopy,
+                pinnedTimestamp
             );
         }
     }
@@ -271,6 +281,7 @@ int getSuccessfulShards() {
             SnapshotInfoBuilder::setRemoteStoreIndexShallowCopy,
             new ParseField(REMOTE_STORE_INDEX_SHALLOW_COPY)
         );
+        SNAPSHOT_INFO_PARSER.declareLong(SnapshotInfoBuilder::setPinnedTimestamp, new ParseField(PINNED_TIMESTAMP));
         SNAPSHOT_INFO_PARSER.declareObjectArray(
             SnapshotInfoBuilder::setShardFailures,
             SnapshotShardFailure.SNAPSHOT_SHARD_FAILURE_PARSER,
@@ -307,6 +318,7 @@ int getSuccessfulShards() {
     @Nullable
     private Boolean remoteStoreIndexShallowCopy;
 
+    private long pinnedTimestamp;
     @Nullable
     private final Map<String, Object> userMetadata;
 
@@ -316,11 +328,11 @@ int getSuccessfulShards() {
     private final List<SnapshotShardFailure> shardFailures;
 
     public SnapshotInfo(SnapshotId snapshotId, List<String> indices, List<String> dataStreams, SnapshotState state) {
-        this(snapshotId, indices, dataStreams, state, null, null, 0L, 0L, 0, 0, Collections.emptyList(), null, null, null);
+        this(snapshotId, indices, dataStreams, state, null, null, 0L, 0L, 0, 0, Collections.emptyList(), null, null, null, 0);
     }
 
     public SnapshotInfo(SnapshotId snapshotId, List<String> indices, List<String> dataStreams, SnapshotState state, Version version) {
-        this(snapshotId, indices, dataStreams, state, null, version, 0L, 0L, 0, 0, Collections.emptyList(), null, null, null);
+        this(snapshotId, indices, dataStreams, state, null, version, 0L, 0L, 0, 0, Collections.emptyList(), null, null, null, 0);
     }
 
     public SnapshotInfo(SnapshotsInProgress.Entry entry) {
@@ -338,7 +350,8 @@ public SnapshotInfo(SnapshotsInProgress.Entry entry) {
             Collections.emptyList(),
             entry.includeGlobalState(),
             entry.userMetadata(),
-            entry.remoteStoreIndexShallowCopy()
+            entry.remoteStoreIndexShallowCopy(),
+            0L
         );
     }
 
@@ -353,7 +366,8 @@ public SnapshotInfo(
         List<SnapshotShardFailure> shardFailures,
         Boolean includeGlobalState,
         Map<String, Object> userMetadata,
-        Boolean remoteStoreIndexShallowCopy
+        Boolean remoteStoreIndexShallowCopy,
+        long pinnedTimestamp
     ) {
         this(
             snapshotId,
@@ -369,7 +383,8 @@ public SnapshotInfo(
             shardFailures,
             includeGlobalState,
             userMetadata,
-            remoteStoreIndexShallowCopy
+            remoteStoreIndexShallowCopy,
+            pinnedTimestamp
         );
     }
 
@@ -387,7 +402,8 @@ public SnapshotInfo(
         List<SnapshotShardFailure> shardFailures,
         Boolean includeGlobalState,
         Map<String, Object> userMetadata,
-        Boolean remoteStoreIndexShallowCopy
+        Boolean remoteStoreIndexShallowCopy,
+        long pinnedTimestamp
     ) {
         this.snapshotId = Objects.requireNonNull(snapshotId);
         this.indices = Collections.unmodifiableList(Objects.requireNonNull(indices));
@@ -403,6 +419,7 @@ public SnapshotInfo(
         this.includeGlobalState = includeGlobalState;
         this.userMetadata = userMetadata;
         this.remoteStoreIndexShallowCopy = remoteStoreIndexShallowCopy;
+        this.pinnedTimestamp = pinnedTimestamp;
     }
 
     /**
@@ -425,6 +442,9 @@ public SnapshotInfo(final StreamInput in) throws IOException {
         if (in.getVersion().onOrAfter(Version.V_2_9_0)) {
             remoteStoreIndexShallowCopy = in.readOptionalBoolean();
         }
+        if (in.getVersion().onOrAfter(Version.V_2_17_0)) {
+            pinnedTimestamp = in.readVLong();
+        }
     }
 
     /**
@@ -539,6 +559,10 @@ public Boolean isRemoteStoreIndexShallowCopyEnabled() {
         return remoteStoreIndexShallowCopy;
     }
 
+    public long getPinnedTimestamp() {
+        return pinnedTimestamp;
+    }
+
     /**
      * Returns shard failures; an empty list will be returned if there were no shard
      * failures, or if {@link #state()} returns {@code null}.
@@ -606,6 +630,8 @@ public String toString() {
             + shardFailures
             + ", isRemoteStoreInteropEnabled="
             + remoteStoreIndexShallowCopy
+            + ", pinnedTimestamp="
+            + pinnedTimestamp
             + '}';
     }
 
@@ -641,6 +667,8 @@ public XContentBuilder toXContent(final XContentBuilder builder, final Params pa
         if (remoteStoreIndexShallowCopy != null) {
             builder.field(REMOTE_STORE_INDEX_SHALLOW_COPY, remoteStoreIndexShallowCopy);
         }
+        builder.field(PINNED_TIMESTAMP, pinnedTimestamp);
+
         builder.startArray(INDICES);
         for (String index : indices) {
             builder.value(index);
@@ -699,6 +727,9 @@ private XContentBuilder toXContentInternal(final XContentBuilder builder, final
         if (remoteStoreIndexShallowCopy != null) {
             builder.field(REMOTE_STORE_INDEX_SHALLOW_COPY, remoteStoreIndexShallowCopy);
         }
+        if (pinnedTimestamp != 0) {
+            builder.field(PINNED_TIMESTAMP, pinnedTimestamp);
+        }
         builder.startArray(INDICES);
         for (String index : indices) {
             builder.value(index);
@@ -747,6 +778,7 @@ public static SnapshotInfo fromXContentInternal(final XContentParser parser) thr
         long endTime = 0;
         int totalShards = 0;
         int successfulShards = 0;
+        long pinnedTimestamp = 0;
         Boolean includeGlobalState = null;
         Boolean remoteStoreIndexShallowCopy = null;
         Map<String, Object> userMetadata = null;
@@ -788,6 +820,8 @@ public static SnapshotInfo fromXContentInternal(final XContentParser parser) thr
                             includeGlobalState = parser.booleanValue();
                         } else if (REMOTE_STORE_INDEX_SHALLOW_COPY.equals(currentFieldName)) {
                             remoteStoreIndexShallowCopy = parser.booleanValue();
+                        } else if (PINNED_TIMESTAMP.equals(currentFieldName)) {
+                            pinnedTimestamp = parser.longValue();
                         }
                     } else if (token == XContentParser.Token.START_ARRAY) {
                         if (DATA_STREAMS.equals(currentFieldName)) {
@@ -840,7 +874,8 @@ public static SnapshotInfo fromXContentInternal(final XContentParser parser) thr
             shardFailures,
             includeGlobalState,
             userMetadata,
-            remoteStoreIndexShallowCopy
+            remoteStoreIndexShallowCopy,
+            pinnedTimestamp
         );
     }
 
@@ -872,6 +907,9 @@ public void writeTo(final StreamOutput out) throws IOException {
         if (out.getVersion().onOrAfter(Version.V_2_9_0)) {
             out.writeOptionalBoolean(remoteStoreIndexShallowCopy);
         }
+        if (out.getVersion().onOrAfter(Version.V_2_17_0)) {
+            out.writeVLong(pinnedTimestamp);
+        }
     }
 
     private static SnapshotState snapshotState(final String reason, final List<SnapshotShardFailure> shardFailures) {
@@ -904,7 +942,8 @@ public boolean equals(Object o) {
             && Objects.equals(version, that.version)
             && Objects.equals(shardFailures, that.shardFailures)
             && Objects.equals(userMetadata, that.userMetadata)
-            && Objects.equals(remoteStoreIndexShallowCopy, that.remoteStoreIndexShallowCopy);
+            && Objects.equals(remoteStoreIndexShallowCopy, that.remoteStoreIndexShallowCopy)
+            && Objects.equals(pinnedTimestamp, that.pinnedTimestamp);
     }
 
     @Override
@@ -924,7 +963,8 @@ public int hashCode() {
             version,
             shardFailures,
             userMetadata,
-            remoteStoreIndexShallowCopy
+            remoteStoreIndexShallowCopy,
+            pinnedTimestamp
         );
     }
 }