Deprecate lack of waiting on shards on index close

In 8.x the default for `?wait_for_active_shards` will change from `NONE` to `DEFAULT` on calls to `POST /index/_close`. This commit adds a deprecation warning in 7.x if this parameter is not specified to encourage users to adopt the new behaviour before upgrading. Closes elastic#66419
DaveCTurner · Dec 17, 2020 · a97b644 · a97b644
1 parent 9a9d480
commit a97b644
Show file tree

Hide file tree

Showing 29 changed files with 69 additions and 2 deletions.
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cat.aliases/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cat.aliases/10_basic.yml
@@ -399,6 +399,7 @@
   - do:
       indices.close:
         index: test_index
+        wait_for_active_shards: DEFAULT
 
   - do:
       cat.aliases:
@@ -432,6 +433,7 @@
   - do:
       indices.close:
         index: test_index
+        wait_for_active_shards: DEFAULT
 
   - do:
       node_selector:

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
@@ -66,6 +66,7 @@
   - do:
       indices.close:
         index: index-2
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:
@@ -107,6 +108,7 @@
   - do:
       indices.close:
         index: index-2
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:
@@ -249,6 +251,7 @@
   - do:
       indices.close:
         index: bar
+        wait_for_active_shards: DEFAULT
 
   - do:
       cat.indices:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cat.recovery/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cat.recovery/10_basic.yml
@@ -93,6 +93,7 @@
   - do:
       indices.close:
         index: index2
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cat.segments/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cat.segments/10_basic.yml
@@ -95,6 +95,7 @@
   - do:
       indices.close:
         index: index1
+        wait_for_active_shards: DEFAULT
 
   - do:
       catch: bad_request

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cluster.allocation_explain/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cluster.allocation_explain/10_basic.yml
@@ -68,6 +68,7 @@
   - do:
       indices.close:
         index: test_closed
+        wait_for_active_shards: DEFAULT
 
   - match: { acknowledged: true }
 

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cluster.health/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cluster.health/10_basic.yml
@@ -183,6 +183,7 @@
   - do:
       indices.close:
         index: index-2
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   # closing the index-2 turns the cluster health back to green
@@ -258,6 +259,7 @@
   - do:
       indices.close:
         index: index-2
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cluster.health/30_indices_options.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cluster.health/30_indices_options.yml
@@ -23,6 +23,7 @@ setup:
   - do:
       indices.close:
         index: index-2
+        wait_for_active_shards: DEFAULT
 
   - do:
       cluster.health:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cluster.state/30_expand_wildcards.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cluster.state/30_expand_wildcards.yml
@@ -25,6 +25,7 @@ setup:
   - do:
       indices.close:
         index: test_close_index
+        wait_for_active_shards: DEFAULT
 
 ---
 "Test expand_wildcards parameter on closed, open indices and both":

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/indices.get/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/indices.get/10_basic.yml
@@ -38,6 +38,7 @@ setup:
   - do:
       indices.close:
         index: test_index_3
+        wait_for_active_shards: DEFAULT
 
   - do:
       cluster.health:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/indices.get/11_basic_with_types.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/indices.get/11_basic_with_types.yml
@@ -37,6 +37,7 @@ setup:
   - do:
       indices.close:
         index: test_index_3
+        wait_for_active_shards: DEFAULT
 
   - do:
       cluster.health:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/indices.get_alias/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/indices.get_alias/10_basic.yml
@@ -307,6 +307,7 @@ setup:
   - do:
       indices.close:
         index: test_index_2
+        wait_for_active_shards: DEFAULT
 
   - do:
       indices.get_alias:

diff --git a/...-spec/src/main/resources/rest-api-spec/test/indices.get_mapping/50_wildcard_expansion.yml b/...-spec/src/main/resources/rest-api-spec/test/indices.get_mapping/50_wildcard_expansion.yml
@@ -52,6 +52,7 @@ setup:
   - do:
       indices.close:
         index: test-xyy
+        wait_for_active_shards: DEFAULT
 
   - do:
         cluster.health:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/indices.open/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/indices.open/10_basic.yml
@@ -14,6 +14,7 @@
   - do:
       indices.close:
         index: test_index
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:
@@ -52,6 +53,7 @@
   - do:
       indices.close:
         index: test_index
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:
@@ -83,6 +85,27 @@
   - match: { acknowledged: true }
   - match: { shards_acknowledged: true }
 ---
+"Close index without specifying wait_for_active_shards":
+  - skip:
+      version: " - 7.1.99"
+      reason:  "closed indices are replicated starting version 7.2.0"
+      features: ["warnings", "node_selector"]
+
+  - do:
+      indices.create:
+        index: test_index
+        body:
+          settings:
+            number_of_replicas: 0
+
+  - do:
+      indices.close:
+        index: test_index
+      warnings:
+        - "When closing an index in 8.0 the default behaviour will change from ?wait_for_active_shards=NONE to ?wait_for_active_shards=DEFAULT. To opt-in to the new default, set ?wait_for_active_shards=DEFAULT when closing indices."
+      node_selector:
+        version: "7.12.0 - "
+---
 "Close index response with result per index":
   - skip:
       version: " - 7.2.99"
@@ -112,6 +135,7 @@
   - do:
       indices.close:
         index: "index_*"
+        wait_for_active_shards: DEFAULT
 
   - match: { acknowledged: true }
   - match: { shards_acknowledged: true }

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/indices.open/20_multiple_indices.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/indices.open/20_multiple_indices.yml
@@ -26,6 +26,7 @@ setup:
   - do:
       indices.close:
         index: _all
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:
@@ -53,6 +54,7 @@ setup:
   - do:
       indices.close:
         index: test_*
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:
@@ -80,6 +82,7 @@ setup:
   - do:
       indices.close:
         index: '*'
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/indices.put_settings/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/indices.put_settings/10_basic.yml
@@ -89,6 +89,7 @@ setup:
   - do:
       indices.close:
         index: test-index
+        wait_for_active_shards: DEFAULT
 
   - do:
       indices.put_settings:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/indices.recovery/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/indices.recovery/10_basic.yml
@@ -56,6 +56,7 @@
   - do:
       indices.close:
         index: test_2
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:

diff --git a/...ec/src/main/resources/rest-api-spec/test/indices.resolve_index/10_basic_resolve_index.yml b/...ec/src/main/resources/rest-api-spec/test/indices.resolve_index/10_basic_resolve_index.yml
@@ -24,6 +24,7 @@ setup:
   - do:
       indices.close:
         index: test_index2
+        wait_for_active_shards: DEFAULT
 
   - do:
       indices.create:

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/indices.segments/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/indices.segments/10_basic.yml
@@ -60,6 +60,7 @@
   - do:
       indices.close:
         index: index1
+        wait_for_active_shards: DEFAULT
 
   - do:
       catch: bad_request

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/search/80_indices_options.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/search/80_indices_options.yml
@@ -34,6 +34,7 @@
   - do:
       indices.close:
           index:  index_closed
+          wait_for_active_shards: DEFAULT
 
   - do:
       catch:  /index_closed_exception/

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/snapshot.restore/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/snapshot.restore/10_basic.yml
@@ -40,6 +40,7 @@ setup:
   - do:
       indices.close:
         index : test_index
+        wait_for_active_shards: DEFAULT
 
   - do:
       snapshot.restore:

diff --git a/server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestCloseIndexAction.java b/server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestCloseIndexAction.java
@@ -24,6 +24,7 @@
 import org.elasticsearch.action.support.IndicesOptions;
 import org.elasticsearch.client.node.NodeClient;
 import org.elasticsearch.common.Strings;
+import org.elasticsearch.common.logging.DeprecationLogger;
 import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
@@ -37,6 +38,8 @@
 
 public class RestCloseIndexAction extends BaseRestHandler {
 
+    private static final DeprecationLogger logger = DeprecationLogger.getLogger(RestCloseIndexAction.class);
+
     @Override
     public List<Route> routes() {
         return unmodifiableList(asList(
@@ -55,8 +58,12 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
         closeIndexRequest.masterNodeTimeout(request.paramAsTime("master_timeout", closeIndexRequest.masterNodeTimeout()));
         closeIndexRequest.timeout(request.paramAsTime("timeout", closeIndexRequest.timeout()));
         closeIndexRequest.indicesOptions(IndicesOptions.fromRequest(request, closeIndexRequest.indicesOptions()));
-        String waitForActiveShards = request.param("wait_for_active_shards");
-        if (waitForActiveShards != null) {
+        final String waitForActiveShards = request.param("wait_for_active_shards");
+        if (waitForActiveShards == null) {
+            logger.deprecate("close-index-wait-for-active-shards", "When closing an index in 8.0 the default behaviour will change from " +
+                    "?wait_for_active_shards=NONE to ?wait_for_active_shards=DEFAULT. To opt-in to the new default, set " +
+                    "?wait_for_active_shards=DEFAULT when closing indices.");
+        } else {
             closeIndexRequest.waitForActiveShards(ActiveShardCount.parseString(waitForActiveShards));
         }
         return channel -> client.admin().indices().close(closeIndexRequest, new RestToXContentListener<>(channel));

diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/test/data_stream/20_unsupported_apis.yml b/x-pack/plugin/src/test/resources/rest-api-spec/test/data_stream/20_unsupported_apis.yml
@@ -45,6 +45,7 @@
   - do:
       indices.close:
         index: logs-*
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
   - length: { indices: 0 }
 
@@ -165,6 +166,7 @@
       catch: bad_request
       indices.close:
         index: ".ds-simple-data-stream1-*000001"
+        wait_for_active_shards: DEFAULT
 
   - do:
       indices.delete_data_stream:

diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/test/data_stream/40_supported_apis.yml b/x-pack/plugin/src/test/resources/rest-api-spec/test/data_stream/40_supported_apis.yml
@@ -230,6 +230,7 @@ teardown:
   - do:
       indices.close:
         index: ".ds-simple-data-stream1-*000001,.ds-simple-data-stream1-*000002"
+        wait_for_active_shards: DEFAULT
   - is_true: acknowledged
 
   - do:

diff --git a/...lugin/src/test/resources/rest-api-spec/test/data_stream/80_resolve_index_data_streams.yml b/...lugin/src/test/resources/rest-api-spec/test/data_stream/80_resolve_index_data_streams.yml
@@ -54,6 +54,7 @@ setup:
   - do:
       indices.close:
         index: test_index2
+        wait_for_active_shards: DEFAULT
 
   - do:
       indices.create:

diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/test/indices.freeze/10_basic.yml b/x-pack/plugin/src/test/resources/rest-api-spec/test/indices.freeze/10_basic.yml
@@ -104,6 +104,7 @@
 - do:
     indices.close:
       index: test-close
+      wait_for_active_shards: DEFAULT
 
 - do:
     indices.freeze:

diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/test/ml/jobs_crud.yml b/x-pack/plugin/src/test/resources/rest-api-spec/test/ml/jobs_crud.yml
@@ -1223,6 +1223,7 @@
   - do:
       indices.close:
         index: ".ml-anomalies-shared"
+        wait_for_active_shards: DEFAULT
 
   - do:
       catch: /Cannot create job \[closed-results-job\] as it requires closed index \[\.ml-anomalies-shared\]/
@@ -1250,6 +1251,7 @@
   - do:
       indices.close:
         index: ".ml-state-000001"
+        wait_for_active_shards: DEFAULT
 
   - do:
       catch: /Cannot create job \[closed-results-job\] as it requires closed index \[\.ml-state-000001\]/

diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/test/monitoring/bulk/10_basic.yml b/x-pack/plugin/src/test/resources/rest-api-spec/test/monitoring/bulk/10_basic.yml
@@ -206,6 +206,7 @@
   - do:
       indices.close:
         index: .monitoring-beats-*
+        wait_for_active_shards: DEFAULT
 
   - do:
       catch: /export_exception/

diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/test/security/authz/14_cat_indices.yml b/x-pack/plugin/src/test/resources/rest-api-spec/test/security/authz/14_cat_indices.yml
@@ -55,6 +55,7 @@ setup:
   - do:
       indices.close:
         index:  index3
+        wait_for_active_shards: DEFAULT
 
 ---
 teardown:
@@ -150,6 +151,7 @@ teardown:
   - do:
       indices.close:
         index:  index_to_monitor
+        wait_for_active_shards: DEFAULT
 
   - do:
       headers: { Authorization: "Basic Y2F0X3VzZXI6Y2F0X3Bhc3N3b3Jk" } # cat_user

diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/test/snapshot/10_basic.yml b/x-pack/plugin/src/test/resources/rest-api-spec/test/snapshot/10_basic.yml
@@ -53,6 +53,7 @@ setup:
   - do:
       indices.close:
         index : test_index
+        wait_for_active_shards: DEFAULT
 
   - do:
       snapshot.restore: