Download funcationality of global metadata from remote store

Signed-off-by: Dhwanil Patel <[email protected]>

server/src/main/java/org/opensearch/gateway/remote/ClusterMetadataManifest.java

@@ -132,6 +132,11 @@ public List<UploadedIndexMetadata> getIndices() {
  return indices;
  }
 
+ // TODO: Remove this once upload PR is merged.
+ public String getGlobalMetadataFileName() {
+ return "global-metadata-file";
+ }
+
  public long getClusterTerm() {
  return clusterTerm;
  }
@@ -366,6 +371,11 @@ public Builder clusterUUIDCommitted(boolean clusterUUIDCommitted) {
  return this;
  }
 
+ // TODO: remove once upload PR is merged.
+ public Builder globalMetadataFileName(String globalMetadatFileName) {
+ return this;
+ }
+
  public Builder() {
  indices = new ArrayList<>();
  }

server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateService.java

@@ -15,6 +15,7 @@
 import org.opensearch.action.LatchedActionListener;
 import org.opensearch.cluster.ClusterState;
 import org.opensearch.cluster.metadata.IndexMetadata;
+import org.opensearch.cluster.metadata.Metadata;
 import org.opensearch.common.Nullable;
 import org.opensearch.common.blobstore.BlobContainer;
 import org.opensearch.common.blobstore.BlobMetadata;
@@ -551,6 +552,41 @@ private IndexMetadata getIndexMetadata(String clusterName, String clusterUUID, U
  }
  }
 
+ /**
+ * Fetch global metadata from remote cluster state
+ *
+ * @param clusterUUID uuid of cluster state to refer to in remote
+ * @param clusterName name of the cluster
+ * @return {@link IndexMetadata}
+ */
+ public Metadata getGlobalMetadata(String clusterName, String clusterUUID) {
+ start();
+ Optional<ClusterMetadataManifest> clusterMetadataManifest = getLatestClusterMetadataManifest(clusterName, clusterUUID);
+ if (!clusterMetadataManifest.isPresent()) {
+ throw new IllegalStateException("Latest index metadata is not present for the provided clusterUUID");
+ }
+ String globalMetadataFileName = clusterMetadataManifest.get().getGlobalMetadataFileName();
+ try {
+ String[] splitPath = globalMetadataFileName.split("/");
+ return BlobStoreRepository.GLOBAL_METADATA_FORMAT.read(
+ globalMetadataContainer(clusterName, clusterUUID),
+ splitPath[splitPath.length - 1],
+ blobStoreRepository.getNamedXContentRegistry()
+ );
+ } catch (IOException e) {
+ throw new IllegalStateException(
+ String.format(Locale.ROOT, "Error while downloading Global Metadata - %s", globalMetadataFileName),
+ e
+ );
+ }
+ }
+
+ // TODO: Remove this once Upload PR is merged
+ private BlobContainer globalMetadataContainer(String clusterName, String clusterUUID) {
+ // 123456789012_test-cluster/cluster-state/dsgYj10Nkso7/global-metadata/
+ return blobStoreRepository.blobStore().blobContainer(getCusterMetadataBasePath(clusterName, clusterUUID).add("global-metadata"));
+ }
+
  /**
  * Fetch latest ClusterMetadataManifest from remote state store
  *

server/src/test/java/org/opensearch/gateway/remote/RemoteClusterStateServiceTests.java

@@ -485,6 +485,83 @@ public void testReadLatestMetadataManifestSuccess() throws IOException {
  assertThat(manifest.getStateUUID(), is(expectedManifest.getStateUUID()));
  }
 
+ public void testReadGlobalMetadata() throws IOException {
+ final ClusterState clusterState = generateClusterStateWithGlobalMetadata().nodes(nodesWithLocalNodeClusterManager()).build();
+ remoteClusterStateService.start();
+
+ final ClusterMetadataManifest expectedManifest = ClusterMetadataManifest.builder()
+ .indices(List.of())
+ .clusterTerm(1L)
+ .stateVersion(1L)
+ .stateUUID("state-uuid")
+ .clusterUUID("cluster-uuid")
+ .globalMetadataFileName("global-metadata-file")
+ .nodeId("nodeA")
+ .opensearchVersion(VersionUtils.randomOpenSearchVersion(random()))
+ .previousClusterUUID("prev-cluster-uuid")
+ .build();
+
+ Metadata expactedMetadata = Metadata.builder().persistentSettings(Settings.builder().put("readonly", true).build()).build();
+ mockBlobContainerForGlobalMetadata(mockBlobStoreObjects(), expectedManifest, expactedMetadata);
+
+ Metadata metadata = remoteClusterStateService.getGlobalMetadata(
+ clusterState.getClusterName().value(),
+ clusterState.metadata().clusterUUID()
+ );
+
+ assertTrue(Metadata.isGlobalStateEquals(metadata, expactedMetadata));
+ }
+
+ public void testReadGlobalMetadataIOException() throws IOException {
+ final ClusterState clusterState = generateClusterStateWithGlobalMetadata().nodes(nodesWithLocalNodeClusterManager()).build();
+ remoteClusterStateService.start();
+ String globalIndexMetadataName = "global-metadata-file";
+ final ClusterMetadataManifest expectedManifest = ClusterMetadataManifest.builder()
+ .indices(List.of())
+ .clusterTerm(1L)
+ .stateVersion(1L)
+ .stateUUID("state-uuid")
+ .clusterUUID("cluster-uuid")
+ .globalMetadataFileName(globalIndexMetadataName)
+ .nodeId("nodeA")
+ .opensearchVersion(VersionUtils.randomOpenSearchVersion(random()))
+ .previousClusterUUID("prev-cluster-uuid")
+ .build();
+
+ Metadata expactedMetadata = Metadata.builder().persistentSettings(Settings.builder().put("readonly", true).build()).build();
+
+ BlobContainer blobContainer = mockBlobStoreObjects();
+ mockBlobContainerForGlobalMetadata(blobContainer, expectedManifest, expactedMetadata);
+
+ when(blobContainer.readBlob(BlobStoreRepository.GLOBAL_METADATA_FORMAT.blobName(globalIndexMetadataName))).thenThrow(
+ FileNotFoundException.class
+ );
+
+ remoteClusterStateService.start();
+ Exception e = assertThrows(
+ IllegalStateException.class,
+ () -> remoteClusterStateService.getGlobalMetadata(clusterState.getClusterName().value(), clusterState.metadata().clusterUUID())
+ );
+ assertEquals(e.getMessage(), "Error while downloading Global Metadata - " + globalIndexMetadataName);
+ }
+
+ // TODO remove this once Upload PR gets merged.
+ private static ClusterState.Builder generateClusterStateWithGlobalMetadata() {
+ final Settings clusterSettings = Settings.builder().put("cluster.blocks.read_only", true).build();
+ final CoordinationMetadata coordinationMetadata = CoordinationMetadata.builder().term(1L).build();
+
+ return ClusterState.builder(ClusterName.DEFAULT)
+ .version(1L)
+ .stateUUID("state-uuid")
+ .metadata(
+ Metadata.builder()
+ .persistentSettings(clusterSettings)
+ .clusterUUID("cluster-uuid")
+ .coordinationMetadata(coordinationMetadata)
+ .build()
+ );
+ }
+
  public void testReadLatestIndexMetadataSuccess() throws IOException {
  final ClusterState clusterState = generateClusterStateWithOneIndex().nodes(nodesWithLocalNodeClusterManager()).build();
  remoteClusterStateService.start();
@@ -796,6 +873,38 @@ private void mockBlobContainer(
  });
  }
 
+ private void mockBlobContainerForGlobalMetadata(
+ BlobContainer blobContainer,
+ ClusterMetadataManifest clusterMetadataManifest,
+ Metadata metadata
+ ) throws IOException {
+ BlobMetadata blobMetadata = new PlainBlobMetadata("manifestFileName", 1);
+ when(
+ blobContainer.listBlobsByPrefixInSortedOrder(
+ "manifest" + RemoteClusterStateService.DELIMITER,
+ 1,
+ BlobContainer.BlobNameSortOrder.LEXICOGRAPHIC
+ )
+ ).thenReturn(Arrays.asList(blobMetadata));
+
+ BytesReference bytes = RemoteClusterStateService.CLUSTER_METADATA_MANIFEST_FORMAT.serialize(
+ clusterMetadataManifest,
+ "manifestFileName",
+ blobStoreRepository.getCompressor()
+ );
+ when(blobContainer.readBlob("manifestFileName")).thenReturn(new ByteArrayInputStream(bytes.streamInput().readAllBytes()));
+
+ BytesReference bytesGlobalMetadata = BlobStoreRepository.GLOBAL_METADATA_FORMAT.serialize(
+ metadata,
+ "global-metadata",
+ blobStoreRepository.getCompressor()
+ );
+ String[] splitPath = clusterMetadataManifest.getGlobalMetadataFileName().split("/");
+ when(blobContainer.readBlob(BlobStoreRepository.GLOBAL_METADATA_FORMAT.blobName(splitPath[splitPath.length - 1]))).thenReturn(
+ new ByteArrayInputStream(bytesGlobalMetadata.streamInput().readAllBytes())
+ );
+ }
+
  private static ClusterState.Builder generateClusterStateWithOneIndex() {
  final Index index = new Index("test-index", "index-uuid");
  final Settings idxSettings = Settings.builder()