Random binary string as prefix to index uuid

Signed-off-by: Ashish Singh <ssashish@amazon.com>
ashking94 · Oct 12, 2023 · c55eb2a · c55eb2a
1 parent 52018ec
commit c55eb2a
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 13 deletions.
diff --git a/buildSrc/src/main/resources/forbidden/opensearch-all-signatures.txt b/buildSrc/src/main/resources/forbidden/opensearch-all-signatures.txt
@@ -21,7 +21,6 @@ java.nio.file.Files#getFileStore(java.nio.file.Path) @ Use org.opensearch.env.En
 java.nio.file.Files#isWritable(java.nio.file.Path) @ Use org.opensearch.env.Environment.isWritable() instead, impacted by JDK-8034057
 
 @defaultMessage Use org.opensearch.common.Randomness#get for reproducible sources of randomness
-java.util.Random#<init>()
 java.util.concurrent.ThreadLocalRandom
 
 java.security.MessageDigest#clone() @ use org.opensearch.common.hash.MessageDigests

diff --git a/buildSrc/src/main/resources/forbidden/opensearch-test-signatures.txt b/buildSrc/src/main/resources/forbidden/opensearch-test-signatures.txt
@@ -26,3 +26,6 @@ com.carrotsearch.randomizedtesting.annotations.Nightly @ We don't run nightly te
 org.junit.Test @defaultMessage Just name your test method testFooBar
 
 java.lang.Math#random() @ Use one of the various randomization methods from LuceneTestCase or OpenSearchTestCase for reproducibility
+
+@defaultMessage Use org.opensearch.common.Randomness#get for reproducible sources of randomness
+java.util.Random#<init>()
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cat.indices/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cat.indices/10_basic.yml
@@ -25,7 +25,7 @@
                /^(green  \s+
                   open   \s+
                   index1 \s+
-                  ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+                  ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
                   1      \s+
                   0      \s+
                   0      \s+
@@ -81,7 +81,7 @@
                /^(        \s+
                   close   \s+
                   index-2 \s+
-                  ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+                  ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
                           \s+
                           \s+
                           \s+
@@ -122,7 +122,7 @@
         /^(green  \s+
            close   \s+
            index-2 \s+
-           ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+           ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
            3       \s+
            0       \s+
                    \s+

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cat.indices/20_hidden.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cat.indices/20_hidden.yml
@@ -27,7 +27,7 @@
         /^(green  \s+
            open   \s+
            index1 \s+
-           ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+           ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
            1      \s+
            0      \s+
            0      \s+
@@ -66,7 +66,7 @@
         /^(green  \s+
            open   \s+
            \.index1 \s+
-           ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+           ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
            1      \s+
            0      \s+
            0      \s+
@@ -111,7 +111,7 @@
         /^(green  \s+
            open   \s+
            index1 \s+
-           ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+           ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
            1      \s+
            0      \s+
            0      \s+
@@ -129,7 +129,7 @@
         /^(green  \s+
            open   \s+
            index1 \s+
-           ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+           ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
            1      \s+
            0      \s+
            0      \s+
@@ -171,7 +171,7 @@
         /^(green  \s+
            open   \s+
            index1 \s+
-           ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+           ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
            1      \s+
            0      \s+
            0      \s+
@@ -189,7 +189,7 @@
         /^(green  \s+
            open   \s+
            index1 \s+
-           ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+           ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
            1      \s+
            0      \s+
            0      \s+
@@ -229,7 +229,7 @@
         /^(green  \s+
            open   \s+
            index1 \s+
-           ([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
+           ([01]{10})?([a-zA-Z0-9=/_+]|[\\\-]){22} \s+
            1      \s+
            0      \s+
            0      \s+

diff --git a/server/src/main/java/org/opensearch/cluster/metadata/MetadataCreateIndexService.java b/server/src/main/java/org/opensearch/cluster/metadata/MetadataCreateIndexService.java
@@ -112,6 +112,7 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Random;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.function.BiConsumer;
@@ -896,7 +897,16 @@ static Settings aggregateIndexSettings(
             indexSettingsBuilder.put(SETTING_CREATION_DATE, Instant.now().toEpochMilli());
         }
         indexSettingsBuilder.put(IndexMetadata.SETTING_INDEX_PROVIDED_NAME, request.getProvidedName());
-        indexSettingsBuilder.put(SETTING_INDEX_UUID, UUIDs.randomBase64UUID());
+
+        String binaryPrefix = "";
+        if (clusterSettings.get(IndicesService.CLUSTER_INDICES_BINARY_PREFIX_INDEX_UUID_SETTING)) {
+            // We generate random binary string of size 10.
+            binaryPrefix = Integer.toBinaryString(new Random().nextInt(1024));
+            if (binaryPrefix.length() < 10) {
+                binaryPrefix = "0".repeat(10 - binaryPrefix.length()) + binaryPrefix;
+            }
+        }
+        indexSettingsBuilder.put(SETTING_INDEX_UUID, binaryPrefix + UUIDs.randomBase64UUID());
 
         updateReplicationStrategy(indexSettingsBuilder, request.settings(), settings);
         updateRemoteStoreSettings(indexSettingsBuilder, settings);

diff --git a/server/src/main/java/org/opensearch/common/settings/ClusterSettings.java b/server/src/main/java/org/opensearch/common/settings/ClusterSettings.java
@@ -678,7 +678,8 @@ public void apply(Settings value, Settings current, Settings previous) {
                 RemoteClusterStateService.REMOTE_CLUSTER_STATE_ENABLED_SETTING,
                 RemoteStoreNodeService.REMOTE_STORE_COMPATIBILITY_MODE_SETTING,
                 IndicesService.CLUSTER_REMOTE_TRANSLOG_BUFFER_INTERVAL_SETTING,
-                IndicesService.CLUSTER_REMOTE_INDEX_RESTRICT_ASYNC_DURABILITY_SETTING
+                IndicesService.CLUSTER_REMOTE_INDEX_RESTRICT_ASYNC_DURABILITY_SETTING,
+                IndicesService.CLUSTER_INDICES_BINARY_PREFIX_INDEX_UUID_SETTING
             )
         )
     );

diff --git a/server/src/main/java/org/opensearch/indices/IndicesService.java b/server/src/main/java/org/opensearch/indices/IndicesService.java
@@ -301,6 +301,16 @@ public class IndicesService extends AbstractLifecycleComponent
         Property.Final
     );
 
+    /**
+     * This setting is used to append binary string (of size 10) prefix to index uuid.
+     */
+    public static final Setting<Boolean> CLUSTER_INDICES_BINARY_PREFIX_INDEX_UUID_SETTING = Setting.boolSetting(
+        "cluster.indices.binary-prefix-index-uuid.enable",
+        false,
+        Property.NodeScope,
+        Property.Dynamic
+    );
+
     /**
      * The node's settings.
      */