Add deprecation notice for max_size rollover condition (#135765)

* Add deprecation notice for max_size rollover condition

* Update docs/changelog/135765.yaml

* Remove erroneous copyright message

* Fill out changelog

* Make deprecation messages more tidy and informative

* Remove the copyright message again

* PR changes

* Update x-pack/plugin/ilm/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/ilm/10_basic.yml

Co-authored-by: Copilot <[email protected]>

* Update x-pack/plugin/ilm/src/main/java/org/elasticsearch/xpack/ilm/action/RestPutLifecycleAction.java

Co-authored-by: Copilot <[email protected]>

* Fix logger class ref

* [CI] Auto commit changes from spotless

* Revert PutLifecycleMetadataService

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: elasticsearchmachine <[email protected]>

Author: 3 people

docs/changelog/135765.yaml

@@ -0,0 +1,11 @@
+pr: 135765
+summary: Add deprecation notice for `max_size` rollover condition
+area: "ILM+SLM"
+type: deprecation
+issues:
+ - 130737
+deprecation:
+  title: Add deprecation notice for `max_size` rollover condition
+  area: "REST API"
+  details: We have deprecated the `max_size` rollover condition, in favour of `max_primary_shard_size`, when used in `PUT /_ilm/policy/{name}` and `POST /{index}/_rollover` endpoints
+  impact: Users can continue to use this condition however a warning will be issued via the response headers and in the server logs. The condition may be removed fully in a later version of Elasticsearch.

rest-api-spec/build.gradle

@@ -100,4 +100,6 @@ tasks.named("yamlRestCompatTestTransform").configure ({ task ->
   task.skipTest("logsdb/10_settings/end time not allowed in logs mode", "we don't validate for index_mode=tsdb when setting start_date/end_date anymore")
   task.skipTest("tsdb/10_settings/set start_time and end_time without timeseries mode", "we don't validate for index_mode=tsdb when setting start_date/end_date anymore")
   task.skipTest("tsdb/10_settings/set start_time, end_time and routing_path via put settings api without time_series mode", "we don't validate for index_mode=tsdb when setting start_date/end_date anymore")
+  // Expected deprecation warning to compat yaml tests:
+  task.addAllowedWarningRegex("Use of the \\[max_size\\] rollover condition has been deprecated in favour of the \\[max_primary_shard_size\\] condition and will be removed in a later version")
 })

rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/indices.rollover/30_max_size_condition.yml

@@ -1,5 +1,82 @@
 ---
 "Rollover with max_size condition":
+  - requires:
+      capabilities:
+        - method: POST
+          path: /logs_search/_rollover
+          capabilities: [ max_size_deprecation ]
+      test_runner_features: [ warnings, capabilities ]
+      reason: Capability required to run test
+
+  # create index with alias and replica
+  - do:
+      indices.create:
+        index: logs-1
+        wait_for_active_shards: 1
+        body:
+          aliases:
+            logs_search: {}
+
+  # index a document
+  - do:
+      index:
+        index: logs-1
+        id:    "1"
+        body:  { "foo": "hello world" }
+        refresh: true
+
+  # perform alias rollover with a large max_size, no action.
+  - do:
+      warnings:
+        - 'Use of the [max_size] rollover condition has been deprecated in favour of the [max_primary_shard_size] condition and will be removed in a later version'
+      indices.rollover:
+        alias: "logs_search"
+        wait_for_active_shards: 1
+        body:
+          conditions:
+            max_size: 100mb
+
+  - match: { conditions: { "[max_size: 100mb]": false } }
+  - match: { rolled_over: false }
+
+  # perform alias rollover with a small max_size, got action.
+  - do:
+      warnings:
+        - 'Use of the [max_size] rollover condition has been deprecated in favour of the [max_primary_shard_size] condition and will be removed in a later version'
+      indices.rollover:
+        alias: "logs_search"
+        wait_for_active_shards: 1
+        body:
+          conditions:
+            max_size: 10b
+
+  - match: { conditions: { "[max_size: 10b]": true } }
+  - match: { rolled_over: true }
+
+  # perform alias rollover on an empty index, no action.
+  - do:
+      warnings:
+        - 'Use of the [max_size] rollover condition has been deprecated in favour of the [max_primary_shard_size] condition and will be removed in a later version'
+      indices.rollover:
+        alias: "logs_search"
+        wait_for_active_shards: 1
+        body:
+          conditions:
+            max_size: 1b
+
+  - match: { conditions: { "[max_size: 1b]": false } }
+  - match: { rolled_over: false }
+
+---
+"Rollover with max_size condition (BWC - Pre Deprecation)":
+  - requires:
+      test_runner_features: [ capabilities ]
+  - skip:
+      capabilities:
+        - method: POST
+          path: /logs_search/_rollover
+          capabilities: [ max_size_deprecation ]
+      reason: Capability must be missing to run test
 
   # create index with alias and replica
   - do:

server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestRolloverIndexAction.java

@@ -12,6 +12,8 @@
 import org.elasticsearch.action.admin.indices.rollover.RolloverRequest;
 import org.elasticsearch.action.support.ActiveShardCount;
 import org.elasticsearch.client.internal.node.NodeClient;
+import org.elasticsearch.common.logging.DeprecationCategory;
+import org.elasticsearch.common.logging.DeprecationLogger;
 import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.Scope;
@@ -30,6 +32,10 @@
 @ServerlessScope(Scope.PUBLIC)
 public class RestRolloverIndexAction extends BaseRestHandler {
 
+    private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(RestRolloverIndexAction.class);
+    public static final String MAX_SIZE_DEPRECATION_MESSAGE = "Use of the [max_size] rollover condition has been deprecated in favour of "
+        + "the [max_primary_shard_size] condition and will be removed in a later version";
+
     @Override
     public List<Route> routes() {
         return List.of(new Route(POST, "/{index}/_rollover"), new Route(POST, "/{index}/_rollover/{new_index}"));
@@ -42,7 +48,7 @@ public String getName() {
 
     @Override
     public Set<String> supportedCapabilities() {
-        return Set.of("return-404-on-missing-target", "index_expression_selectors");
+        return Set.of("return-404-on-missing-target", "index_expression_selectors", "max_size_deprecation");
     }
 
     @Override
@@ -55,6 +61,12 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
         rolloverIndexRequest.masterNodeTimeout(getMasterNodeTimeout(request));
         rolloverIndexRequest.getCreateIndexRequest()
             .waitForActiveShards(ActiveShardCount.parseString(request.param("wait_for_active_shards")));
+
+        // Check for deprecated conditions
+        if (rolloverIndexRequest.getConditions().getMaxSize() != null) {
+            DEPRECATION_LOGGER.warn(DeprecationCategory.API, "rollover-max-size-condition", MAX_SIZE_DEPRECATION_MESSAGE);
+        }
+
         return channel -> new RestCancellableNodeClient(client, request.getHttpChannel()).admin()
             .indices()
             .rolloverIndex(rolloverIndexRequest, new RestToXContentListener<>(channel));

x-pack/plugin/ilm/qa/multi-cluster/src/test/java/org/elasticsearch/xpack/ilm/CCRIndexLifecycleIT.java

@@ -11,6 +11,7 @@
 import org.apache.http.util.EntityUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.logging.log4j.message.ParameterizedMessage;
 import org.elasticsearch.client.Request;
 import org.elasticsearch.client.Response;
 import org.elasticsearch.client.ResponseException;
@@ -31,6 +32,7 @@
 import org.elasticsearch.xpack.core.ilm.Phase;
 import org.elasticsearch.xpack.core.ilm.UnfollowAction;
 import org.elasticsearch.xpack.core.ilm.WaitUntilTimeSeriesEndTimePassesStep;
+import org.elasticsearch.xpack.ilm.action.RestPutLifecycleAction;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -53,6 +55,7 @@
 public class CCRIndexLifecycleIT extends ESCCRRestTestCase {
 
     private static final Logger LOGGER = LogManager.getLogger(CCRIndexLifecycleIT.class);
+    private static final String TEST_PHASE = "hot";
     private static final String TSDB_INDEX_TEMPLATE = """
         {
             "index_patterns": ["%s*"],
@@ -677,7 +680,7 @@ private static void putILMPolicy(String name, String maxSize, Integer maxDocs, T
             {
                 builder.startObject("phases");
                 {
-                    builder.startObject("hot");
+                    builder.startObject(TEST_PHASE);
                     {
                         builder.startObject("actions");
                         {
@@ -733,6 +736,13 @@ private static void putILMPolicy(String name, String maxSize, Integer maxDocs, T
         }
         builder.endObject();
         request.setJsonEntity(Strings.toString(builder));
+        if (maxSize != null) {
+            request.setOptions(
+                expectWarnings(
+                    ParameterizedMessage.format(RestPutLifecycleAction.MAX_SIZE_DEPRECATION_MESSAGE, new Object[] { TEST_PHASE })
+                )
+            );
+        }
         assertOK(client().performRequest(request));
     }
 

x-pack/plugin/ilm/qa/rest/build.gradle

@@ -8,7 +8,7 @@ dependencies {
 
 restResources {
   restApi {
-    include '_common', 'cluster', 'indices', 'index', 'snapshot', 'ilm', 'slm', 'health_report'
+    include '_common', 'cluster', 'indices', 'index', 'snapshot', 'ilm', 'slm', 'health_report', 'capabilities'
   }
 }
 

x-pack/plugin/ilm/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/ilm/10_basic.yml

@@ -395,3 +395,99 @@ setup:
                }
              }
            }
+
+---
+# This test checks that the deprecation warning is issued when a deprecated rollover condition is part of the policy
+# On both creation and update of an existing policy
+"Test Deprecated Condition On Policy Put / Update":
+  - requires:
+      test_runner_features: [ warnings, capabilities ]
+      capabilities:
+        - method: PUT
+          path: /_ilm/policy/my_timeseries_lifecycle
+          capabilities: [ max_size_deprecation ]
+      reason: Capability must be present to run test
+
+  - do:
+      warnings:
+        - 'Use of the [max_size] rollover condition found in phase [hot]. This condition has been deprecated in favour of the [max_primary_shard_size] condition and will be removed in a later version'
+      ilm.put_lifecycle:
+        policy: "my_timeseries_lifecycle"
+        body: |
+          {
+            "policy": {
+              "phases": {
+                "hot": {
+                  "actions": {
+                    "rollover": {
+                      "max_size": "50gb"
+                    }
+                  }
+                }
+              }
+            }
+          }
+
+  - do:
+      ilm.get_lifecycle:
+        policy: "my_timeseries_lifecycle"
+  - match: { my_timeseries_lifecycle.version: 1 }
+  - is_true: my_timeseries_lifecycle.modified_date
+  - match: { my_timeseries_lifecycle.policy.phases.hot.actions.rollover.max_size: "50gb" }
+
+  # Create a policy with rollover but without max_size
+  - do:
+      ilm.put_lifecycle:
+        policy: "my_timeseries_lifecycle_update"
+        body: |
+          {
+            "policy": {
+              "phases": {
+                "hot": {
+                  "actions": {
+                    "rollover": {
+                      "max_docs": 1000
+                    }
+                  }
+                }
+              }
+            }
+          }
+
+  - do:
+      ilm.get_lifecycle:
+        policy: "my_timeseries_lifecycle_update"
+  - match: { my_timeseries_lifecycle_update.version: 1 }
+  - is_true: my_timeseries_lifecycle_update.modified_date
+  - match: { my_timeseries_lifecycle_update.policy.phases.hot.actions.rollover.max_docs: 1000 }
+  - is_false: my_timeseries_lifecycle_update.policy.phases.hot.actions.rollover.max_size
+
+  # Update the policy to add max_size and check for deprecation warning
+  - do:
+      warnings:
+        - 'Use of the [max_size] rollover condition found in phase [hot]. This condition has been deprecated in favour of the [max_primary_shard_size] condition and will be removed in a later version'
+      ilm.put_lifecycle:
+        policy: "my_timeseries_lifecycle_update"
+        body: |
+          {
+            "policy": {
+              "phases": {
+                "hot": {
+                  "actions": {
+                    "rollover": {
+                      "max_docs": 1000,
+                      "max_size": "25gb"
+                    }
+                  }
+                }
+              }
+            }
+          }
+
+  - do:
+      ilm.get_lifecycle:
+        policy: "my_timeseries_lifecycle_update"
+  - match: { my_timeseries_lifecycle_update.version: 2 }
+  - is_true: my_timeseries_lifecycle_update.modified_date
+  - match: { my_timeseries_lifecycle_update.policy.phases.hot.actions.rollover.max_docs: 1000 }
+  - match: { my_timeseries_lifecycle_update.policy.phases.hot.actions.rollover.max_size: "25gb" }

x-pack/plugin/ilm/src/main/java/org/elasticsearch/xpack/ilm/action/RestPutLifecycleAction.java

@@ -8,22 +8,33 @@
 package org.elasticsearch.xpack.ilm.action;
 
 import org.elasticsearch.client.internal.node.NodeClient;
+import org.elasticsearch.common.logging.DeprecationCategory;
+import org.elasticsearch.common.logging.DeprecationLogger;
 import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
+import org.elasticsearch.xpack.core.ilm.LifecycleAction;
 import org.elasticsearch.xpack.core.ilm.LifecyclePolicy;
+import org.elasticsearch.xpack.core.ilm.Phase;
+import org.elasticsearch.xpack.core.ilm.RolloverAction;
 import org.elasticsearch.xpack.core.ilm.action.ILMActions;
 import org.elasticsearch.xpack.core.ilm.action.PutLifecycleRequest;
 
 import java.io.IOException;
 import java.util.List;
+import java.util.Set;
 
 import static org.elasticsearch.rest.RestRequest.Method.PUT;
 import static org.elasticsearch.rest.RestUtils.getAckTimeout;
 import static org.elasticsearch.rest.RestUtils.getMasterNodeTimeout;
 
 public class RestPutLifecycleAction extends BaseRestHandler {
 
+    private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(RestPutLifecycleAction.class);
+
+    public static final String MAX_SIZE_DEPRECATION_MESSAGE = "Use of the [max_size] rollover condition found in phase [{}]. This"
+        + " condition has been deprecated in favour of the [max_primary_shard_size] condition and will be removed in a later version";
+
     @Override
     public List<Route> routes() {
         return List.of(new Route(PUT, "/_ilm/policy/{name}"));
@@ -50,6 +61,28 @@ public String getPolicyName() {
                 }
             }, parser);
         }
+
+        // Check for deprecated rollover conditions
+        for (Phase phase : putLifecycleRequest.getPolicy().getPhases().values()) {
+            for (LifecycleAction actionObj : phase.getActions().values()) {
+                if (actionObj instanceof RolloverAction rolloverAction) {
+                    if (rolloverAction.getConditions().getMaxSize() != null) {
+                        DEPRECATION_LOGGER.warn(
+                            DeprecationCategory.API,
+                            "rollover-max-size-condition",
+                            MAX_SIZE_DEPRECATION_MESSAGE,
+                            phase.getName()
+                        );
+                    }
+                }
+            }
+        }
+
         return channel -> client.execute(ILMActions.PUT, putLifecycleRequest, new RestToXContentListener<>(channel));
     }
+
+    @Override
+    public Set<String> supportedCapabilities() {
+        return Set.of("max_size_deprecation");
+    }
 }