Switch built-in policies to max_primary_shard_size (#69995)

joegallo · web-flow · commit f93242a5f945 · 2021-03-04T17:00:45.000-05:00
diff --git a/docs/reference/data-streams/change-mappings-and-settings.asciidoc b/docs/reference/data-streams/change-mappings-and-settings.asciidoc
@@ -35,7 +35,7 @@ PUT /_ilm/policy/my-data-stream-policy
       "hot": {
         "actions": {
           "rollover": {
-            "max_size": "25GB"
+            "max_primary_shard_size": "25GB"
           }
         }
       },
diff --git a/docs/reference/data-streams/set-up-a-data-stream.asciidoc b/docs/reference/data-streams/set-up-a-data-stream.asciidoc
@@ -40,7 +40,7 @@ PUT /_ilm/policy/my-data-stream-policy
       "hot": {
         "actions": {
           "rollover": {
-            "max_size": "25GB"
+            "max_primary_shard_size": "25GB"
           }
         }
       },
diff --git a/docs/reference/ilm/actions/ilm-rollover.asciidoc b/docs/reference/ilm/actions/ilm-rollover.asciidoc
@@ -84,6 +84,29 @@ shard is a primary (`p`) or a replica (`r`).
 [[ilm-rollover-ex]]
 ==== Example
 
+[[ilm-rollover-primar-shardsize-ex]]
+===== Roll over based on largest primary shard size
+
+This example rolls the index over when its largest primary shard is at least 50 gigabytes.
+
+[source,console]
+--------------------------------------------------
+PUT _ilm/policy/my_policy
+{
+  "policy": {
+    "phases": {
+      "hot": {
+        "actions": {
+          "rollover" : {
+            "max_primary_shard_size": "50GB"
+          }
+        }
+      }
+    }
+  }
+}
+--------------------------------------------------
+
 [[ilm-rollover-size-ex]]
 ===== Roll over based on index size
 
diff --git a/docs/reference/ilm/ilm-tutorial.asciidoc b/docs/reference/ilm/ilm-tutorial.asciidoc
@@ -51,7 +51,7 @@ and the actions to perform in each phase. A lifecycle can have up to five phases
 For example, you might define a `timeseries_policy` that has two phases:
 
 * A `hot` phase that defines a rollover action to specify that an index rolls over when it
-reaches either a `max_size` of 50 gigabytes or a `max_age` of 30 days.
+reaches either a `max_primary_shard_size` of 50 gigabytes or a `max_age` of 30 days.
 * A `delete` phase that sets `min_age` to remove the index 90 days after rollover.
 Note that this value is relative to the rollover time, not the index creation time.
 
@@ -72,18 +72,18 @@ PUT _ilm/policy/timeseries_policy
 {
   "policy": {
     "phases": {
-      "hot": {                      <1>
+      "hot": {                                <1>
         "actions": {
           "rollover": {
-            "max_size": "50GB",     <2>
+            "max_primary_shard_size": "50GB", <2>
             "max_age": "30d"
           }
         }
       },
       "delete": {
-        "min_age": "90d",           <3>
+        "min_age": "90d",                     <3>
         "actions": {
-          "delete": {}              <4>
+          "delete": {}                        <4>
         }
       }
     }
@@ -232,7 +232,7 @@ is met.
           "min_age": "0ms",
           "actions": {
             "rollover": {
-              "max_size": "50gb",
+              "max_primary_shard_size": "50gb",
               "max_age": "30d"
             }
           }
diff --git a/docs/reference/ilm/set-up-lifecycle-policy.asciidoc b/docs/reference/ilm/set-up-lifecycle-policy.asciidoc
@@ -49,7 +49,7 @@ PUT _ilm/policy/my_policy
       "hot": {
         "actions": {
           "rollover": {
-            "max_size": "25GB" <1>
+            "max_primary_shard_size": "25GB" <1>
           }
         }
       },
diff --git a/docs/reference/indices/get-data-stream.asciidoc b/docs/reference/indices/get-data-stream.asciidoc
@@ -18,7 +18,7 @@ PUT /_ilm/policy/my-lifecycle-policy
       "hot": {
         "actions": {
           "rollover": {
-            "max_size": "25GB"
+            "max_primary_shard_size": "25GB"
           }
         }
       },
diff --git a/x-pack/plugin/core/src/main/resources/ilm-history-ilm-policy.json b/x-pack/plugin/core/src/main/resources/ilm-history-ilm-policy.json
@@ -3,7 +3,7 @@
     "hot": {
       "actions": {
         "rollover": {
-          "max_size": "50GB",
+          "max_primary_shard_size": "50gb",
           "max_age": "30d"
         }
       }
diff --git a/x-pack/plugin/core/src/main/resources/logs-policy.json b/x-pack/plugin/core/src/main/resources/logs-policy.json
@@ -3,7 +3,7 @@
     "hot": {
       "actions": {
         "rollover": {
-          "max_size": "50gb",
+          "max_primary_shard_size": "50gb",
           "max_age": "30d"
         }
       }
diff --git a/x-pack/plugin/core/src/main/resources/metrics-policy.json b/x-pack/plugin/core/src/main/resources/metrics-policy.json
@@ -3,7 +3,7 @@
     "hot": {
       "actions": {
         "rollover": {
-          "max_size": "50gb",
+          "max_primary_shard_size": "50gb",
           "max_age": "30d"
         }
       }
diff --git a/x-pack/plugin/core/src/main/resources/org/elasticsearch/xpack/core/ml/size_based_ilm_policy.json b/x-pack/plugin/core/src/main/resources/org/elasticsearch/xpack/core/ml/size_based_ilm_policy.json
@@ -3,7 +3,7 @@
     "hot": {
       "actions": {
         "rollover": {
-          "max_size": "50GB"
+          "max_primary_shard_size": "50gb"
         }
       }
     }
diff --git a/x-pack/plugin/core/src/main/resources/org/elasticsearch/xpack/deprecation/deprecation-indexing-ilm-policy.json b/x-pack/plugin/core/src/main/resources/org/elasticsearch/xpack/deprecation/deprecation-indexing-ilm-policy.json
@@ -3,7 +3,7 @@
     "hot": {
       "actions": {
         "rollover": {
-          "max_size": "50gb",
+          "max_primary_shard_size": "50gb",
           "max_age": "30d"
         }
       }
diff --git a/x-pack/plugin/core/src/main/resources/slm-history-ilm-policy.json b/x-pack/plugin/core/src/main/resources/slm-history-ilm-policy.json
@@ -3,7 +3,7 @@
     "hot": {
       "actions": {
         "rollover": {
-          "max_size": "50GB",
+          "max_primary_shard_size": "50gb",
           "max_age": "30d"
         }
       }
diff --git a/x-pack/plugin/core/src/main/resources/synthetics-policy.json b/x-pack/plugin/core/src/main/resources/synthetics-policy.json
@@ -3,7 +3,7 @@
     "hot": {
       "actions": {
         "rollover": {
-          "max_size": "50gb",
+          "max_primary_shard_size": "50gb",
           "max_age": "30d"
         }
       }

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ PUT /_ilm/policy/my-data-stream-policy`
`35`	`35`	`"hot": {`
`36`	`36`	`"actions": {`
`37`	`37`	`"rollover": {`
`38`		`- "max_size": "25GB"`
	`38`	`+ "max_primary_shard_size": "25GB"`
`39`	`39`	`}`
`40`	`40`	`}`
`41`	`41`	`},`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ PUT /_ilm/policy/my-data-stream-policy`
`40`	`40`	`"hot": {`
`41`	`41`	`"actions": {`
`42`	`42`	`"rollover": {`
`43`		`- "max_size": "25GB"`
	`43`	`+ "max_primary_shard_size": "25GB"`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`	`},`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ and the actions to perform in each phase. A lifecycle can have up to five phases`
`51`	`51`	For example, you might define a `timeseries_policy` that has two phases:
`52`	`52`
`53`	`53`	* A `hot` phase that defines a rollover action to specify that an index rolls over when it
`54`		-reaches either a `max_size` of 50 gigabytes or a `max_age` of 30 days.
	`54`	+reaches either a `max_primary_shard_size` of 50 gigabytes or a `max_age` of 30 days.
`55`	`55`	* A `delete` phase that sets `min_age` to remove the index 90 days after rollover.
`56`	`56`	`Note that this value is relative to the rollover time, not the index creation time.`
`57`	`57`
`@@ -72,18 +72,18 @@ PUT _ilm/policy/timeseries_policy`
`72`	`72`	`{`
`73`	`73`	`"policy": {`
`74`	`74`	`"phases": {`
`75`		`- "hot": { <1>`
	`75`	`+ "hot": { <1>`
`76`	`76`	`"actions": {`
`77`	`77`	`"rollover": {`
`78`		`- "max_size": "50GB", <2>`
	`78`	`+ "max_primary_shard_size": "50GB", <2>`
`79`	`79`	`"max_age": "30d"`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`	`},`
`83`	`83`	`"delete": {`
`84`		`- "min_age": "90d", <3>`
	`84`	`+ "min_age": "90d", <3>`
`85`	`85`	`"actions": {`
`86`		`- "delete": {} <4>`
	`86`	`+ "delete": {} <4>`
`87`	`87`	`}`
`88`	`88`	`}`
`89`	`89`	`}`
`@@ -232,7 +232,7 @@ is met.`
`232`	`232`	`"min_age": "0ms",`
`233`	`233`	`"actions": {`
`234`	`234`	`"rollover": {`
`235`		`- "max_size": "50gb",`
	`235`	`+ "max_primary_shard_size": "50gb",`
`236`	`236`	`"max_age": "30d"`
`237`	`237`	`}`
`238`	`238`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ PUT _ilm/policy/my_policy`
`49`	`49`	`"hot": {`
`50`	`50`	`"actions": {`
`51`	`51`	`"rollover": {`
`52`		`- "max_size": "25GB" <1>`
	`52`	`+ "max_primary_shard_size": "25GB" <1>`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`	`},`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ PUT /_ilm/policy/my-lifecycle-policy`
`18`	`18`	`"hot": {`
`19`	`19`	`"actions": {`
`20`	`20`	`"rollover": {`
`21`		`- "max_size": "25GB"`
	`21`	`+ "max_primary_shard_size": "25GB"`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`	`},`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"hot": {`
`4`	`4`	`"actions": {`
`5`	`5`	`"rollover": {`
`6`		`- "max_size": "50GB",`
	`6`	`+ "max_primary_shard_size": "50gb",`
`7`	`7`	`"max_age": "30d"`
`8`	`8`	`}`
`9`	`9`	`}`