Update Documentation URLs (#125089) (#127165)

* ES-9508 Update Data Steam Deprecation notice text and URL

Also updates the text to use a dynamic placeholder for version number so code can be backported without change

* ES-9508 ILM Policy deprecation checker URL to short URL

* ES-9508 Index version deprecation notices

* ES-9508 Translog Retention Deprecation URL

* ES-9508 Index data path deprecation URL

* ES-9508 Simplefs deprecation

* ES-9508 Datafeed deprecated options notice

* ES-9508 Datafeed deprecated aggregation options notice

* ES-9508 Model snapshot version deprecation notice

* ES-9508 Shared data path setting deprecation

* ES-9508 Realm prefix deprecation

* ES-9508 eql enable deprecation

* ES-9508 Watcher setting deprecation

* ES-9508 Formatting changes

* Update x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/DataStreamDeprecationChecker.java

Co-authored-by: Mary Gouseti <[email protected]>

* Update x-pack/plugin/deprecation/src/test/java/org/elasticsearch/xpack/deprecation/DataStreamDeprecationCheckerTests.java

Co-authored-by: Mary Gouseti <[email protected]>

* ES-9508 Update index and data stream deprecation notices to be backport proof

* [CI] Auto commit changes from spotless

---------

Co-authored-by: Mary Gouseti <[email protected]>
Co-authored-by: elasticsearchmachine <[email protected]>
(cherry picked from commit 68b8145)

Author: 3 people

x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/DataStreamDeprecationChecker.java

@@ -7,6 +7,7 @@
 
 package org.elasticsearch.xpack.deprecation;
 
+import org.elasticsearch.Version;
 import org.elasticsearch.action.support.IndicesOptions;
 import org.elasticsearch.cluster.ClusterState;
 import org.elasticsearch.cluster.metadata.DataStream;
@@ -93,9 +94,9 @@ static DeprecationIssue oldIndicesCheck(DataStream dataStream, ClusterState clus
         if (indicesNeedingUpgrade.isEmpty() == false) {
             return new DeprecationIssue(
                 DeprecationIssue.Level.CRITICAL,
-                "Old data stream with a compatibility version < 9.0",
-                "https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-9.0.html",
-                "This data stream has backing indices that were created before Elasticsearch 9.0.0",
+                "Old data stream with a compatibility version < " + Version.CURRENT.major + ".0",
+                "https://ela.st/es-deprecation-ds-reindex",
+                "This data stream has backing indices that were created before Elasticsearch " + Version.CURRENT.major + ".0",
                 false,
                 ofEntries(
                     entry("reindex_required", true),
@@ -115,10 +116,11 @@ static DeprecationIssue ignoredOldIndicesCheck(DataStream dataStream, ClusterSta
         if (ignoredIndices.isEmpty() == false) {
             return new DeprecationIssue(
                 DeprecationIssue.Level.WARNING,
-                "Old data stream with a compatibility version < 9.0 Have Been Ignored",
-                "https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-9.0.html",
-                "This data stream has read only backing indices that were created before Elasticsearch 9.0.0 and have been marked as "
-                    + "OK to remain read-only after upgrade",
+                "Old data stream with a compatibility version < " + Version.CURRENT.major + ".0 has Been Ignored",
+                "https://ela.st/es-deprecation-ds-reindex",
+                "This data stream has read only backing indices that were created before Elasticsearch "
+                    + Version.CURRENT.major
+                    + ".0 and have been marked as OK to remain read-only after upgrade",
                 false,
                 ofEntries(
                     entry("reindex_required", false),

x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/IlmPolicyDeprecationChecker.java

@@ -104,7 +104,7 @@ private DeprecationIssue checkFrozenAction(LifecyclePolicy policy) {
                     "ILM policy ["
                         + policy.getName()
                         + "] contains the action 'freeze' that is deprecated and will be removed in a future version.",
-                    "https://www.elastic.co/guide/en/elasticsearch/reference/master/frozen-indices.html",
+                    "https://ela.st/es-deprecation-7-frozen-index",
                     "This action is already a noop so it can be safely removed, because frozen indices no longer offer any advantages."
                         + " Consider cold or frozen tiers in place of frozen indices.",
                     false,

x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/IndexDeprecationChecker.java

@@ -6,6 +6,7 @@
  */
 package org.elasticsearch.xpack.deprecation;
 
+import org.elasticsearch.Version;
 import org.elasticsearch.cluster.ClusterState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
@@ -100,14 +101,14 @@ private DeprecationIssue oldIndicesCheck(
             if (transforms.isEmpty() == false) {
                 return new DeprecationIssue(
                     DeprecationIssue.Level.CRITICAL,
-                    "One or more Transforms write to this index with a compatibility version < 9.0",
-                    "https://www.elastic.co/guide/en/elastic-stack/9.0/upgrading-elastic-stack.html"
-                        + "#breaking_90_transform_destination_index",
+                    "One or more Transforms write to this index with a compatibility version < " + Version.CURRENT.major + ".0",
+                    "https://ela.st/es-deprecation-9-transform-destination-index",
                     Strings.format(
-                        "This index was created in version [%s] and requires action before upgrading to 9.0. The following transforms are "
+                        "This index was created in version [%s] and requires action before upgrading to %d.0. The following transforms are "
                             + "configured to write to this index: [%s]. Refer to the migration guide to learn more about how to prepare "
                             + "transforms destination indices for your upgrade.",
                         currentCompatibilityVersion.toReleaseVersion(),
+                        Version.CURRENT.major,
                         String.join(", ", transforms)
                     ),
                     false,
@@ -116,8 +117,8 @@ private DeprecationIssue oldIndicesCheck(
             } else {
                 return new DeprecationIssue(
                     DeprecationIssue.Level.CRITICAL,
-                    "Old index with a compatibility version < 9.0",
-                    "https://www.elastic.co/guide/en/elastic-stack/9.0/upgrading-elastic-stack.html",
+                    "Old index with a compatibility version < " + Version.CURRENT.major + ".0",
+                    "https://ela.st/es-deprecation-9-index-version",
                     "This index has version: " + currentCompatibilityVersion.toReleaseVersion(),
                     false,
                     Map.of("reindex_required", true)
@@ -143,14 +144,14 @@ private DeprecationIssue ignoredOldIndicesCheck(
             if (transforms.isEmpty() == false) {
                 return new DeprecationIssue(
                     DeprecationIssue.Level.WARNING,
-                    "One or more Transforms write to this old index with a compatibility version < 9.0",
-                    "https://www.elastic.co/guide/en/elastic-stack/9.0/upgrading-elastic-stack.html"
-                        + "#breaking_90_transform_destination_index",
+                    "One or more Transforms write to this old index with a compatibility version < " + Version.CURRENT.major + ".0",
+                    "https://ela.st/es-deprecation-9-transform-destination-index",
                     Strings.format(
-                        "This index was created in version [%s] and will be supported as a read-only index in 9.0. The following "
+                        "This index was created in version [%s] and will be supported as a read-only index in %d.0. The following "
                             + "transforms are no longer able to write to this index: [%s]. Refer to the migration guide to learn more "
                             + "about how to handle your transforms destination indices.",
                         currentCompatibilityVersion.toReleaseVersion(),
+                        Version.CURRENT.major,
                         String.join(", ", transforms)
                     ),
                     false,
@@ -159,11 +160,13 @@ private DeprecationIssue ignoredOldIndicesCheck(
             } else {
                 return new DeprecationIssue(
                     DeprecationIssue.Level.WARNING,
-                    "Old index with a compatibility version < 9.0 has been ignored",
-                    "https://www.elastic.co/guide/en/elastic-stack/9.0/upgrading-elastic-stack.html",
+                    "Old index with a compatibility version < " + Version.CURRENT.major + ".0 has been ignored",
+                    "https://ela.st/es-deprecation-9-index-version",
                     "This read-only index has version: "
                         + currentCompatibilityVersion.toReleaseVersion()
-                        + " and will be supported as read-only in 9.0",
+                        + " and will be supported as read-only in "
+                        + Version.CURRENT.major
+                        + ".0",
                     false,
                     Map.of("reindex_required", true)
                 );
@@ -196,7 +199,7 @@ private DeprecationIssue translogRetentionSettingCheck(
                 return new DeprecationIssue(
                     DeprecationIssue.Level.WARNING,
                     "translog retention settings are ignored",
-                    "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-translog.html",
+                    "https://ela.st/es-deprecation-7-translog-retention",
                     "translog retention settings [index.translog.retention.size] and [index.translog.retention.age] are ignored "
                         + "because translog is no longer used in peer recoveries with soft-deletes enabled (default in 7.0 or later)",
                     false,
@@ -214,8 +217,7 @@ private DeprecationIssue checkIndexDataPath(IndexMetadata indexMetadata, Cluster
                 "setting [%s] is deprecated and will be removed in a future version",
                 IndexMetadata.INDEX_DATA_PATH_SETTING.getKey()
             );
-            final String url = "https://www.elastic.co/guide/en/elasticsearch/reference/7.13/"
-                + "breaking-changes-7.13.html#deprecate-shared-data-path-setting";
+            final String url = "https://ela.st/es-deprecation-7-index-data-path";
             final String details = "Found index data path configured. Discontinue use of this setting.";
             return new DeprecationIssue(DeprecationIssue.Level.WARNING, message, url, details, false, null);
         }
@@ -232,7 +234,7 @@ private DeprecationIssue storeTypeSettingCheck(
             return new DeprecationIssue(
                 DeprecationIssue.Level.WARNING,
                 "[simplefs] is deprecated and will be removed in future versions",
-                "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-store.html",
+                "https://ela.st/es-deprecation-7-simplefs",
                 "[simplefs] is deprecated and will be removed in 8.0. Use [niofs] or other file systems instead. "
                     + "Elasticsearch 7.15 or later uses [niofs] for the [simplefs] store type "
                     + "as it offers superior or equivalent performance to [simplefs].",

x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/MlDeprecationChecker.java

@@ -39,7 +39,7 @@ static Optional<DeprecationIssue> checkDataFeedQuery(DatafeedConfig datafeedConf
                 new DeprecationIssue(
                     DeprecationIssue.Level.WARNING,
                     "Datafeed [" + datafeedConfig.getId() + "] uses deprecated query options",
-                    "https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html#breaking_70_search_changes",
+                    "https://ela.st/es-deprecation-7-data-feed-query",
                     deprecations.toString(),
                     false,
                     null
@@ -57,8 +57,7 @@ static Optional<DeprecationIssue> checkDataFeedAggregations(DatafeedConfig dataf
                 new DeprecationIssue(
                     DeprecationIssue.Level.WARNING,
                     "Datafeed [" + datafeedConfig.getId() + "] uses deprecated aggregation options",
-                    "https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html"
-                        + "#breaking_70_aggregations_changes",
+                    "https://ela.st/es-deprecation-7-data-feed-aggregation",
                     deprecations.toString(),
                     false,
                     null
@@ -98,7 +97,7 @@ static Optional<DeprecationIssue> checkModelSnapshot(ModelSnapshot modelSnapshot
                         modelSnapshot.getJobId(),
                         modelSnapshot.getMinVersion()
                     ),
-                    "https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-upgrade-job-model-snapshot.html",
+                    "https://ela.st/es-deprecation-8-model-snapshot-version",
                     details.toString(),
                     false,
                     Map.of("job_id", modelSnapshot.getJobId(), "snapshot_id", modelSnapshot.getSnapshotId())

x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecks.java

@@ -251,8 +251,7 @@ static DeprecationIssue checkSharedDataPathSetting(
                 "setting [%s] is deprecated and will be removed in a future version",
                 Environment.PATH_SHARED_DATA_SETTING.getKey()
             );
-            final String url = "https://www.elastic.co/guide/en/elasticsearch/reference/7.13/"
-                + "breaking-changes-7.13.html#deprecate-shared-data-path-setting";
+            final String url = "https://ela.st/es-deprecation-7-shared-data-path";
             final String details = "Found shared data path configured. Discontinue use of this setting.";
             return new DeprecationIssue(DeprecationIssue.Level.WARNING, message, url, details, false, null);
         }
@@ -281,7 +280,7 @@ static DeprecationIssue checkReservedPrefixedRealmNames(
             return new DeprecationIssue(
                 DeprecationIssue.Level.CRITICAL,
                 "Realm that start with [" + RESERVED_REALM_AND_DOMAIN_NAME_PREFIX + "] will not be permitted in a future major release.",
-                "https://www.elastic.co/guide/en/elasticsearch/reference/7.14/deprecated-7.14.html#reserved-prefixed-realm-names",
+                "https://ela.st/es-deprecation-7-realm-prefix",
                 String.format(
                     Locale.ROOT,
                     "Found realm "
@@ -972,7 +971,7 @@ static DeprecationIssue checkEqlEnabledSetting(
             Setting.Property.NodeScope,
             Setting.Property.DeprecatedWarning
         );
-        String url = "https://ela.st/es-deprecation-8-eql-enabled-setting";
+        String url = "https://ela.st/es-deprecation-7-eql-enabled-setting";
         return checkRemovedSetting(
             clusterState.metadata().settings(),
             settings,
@@ -1019,7 +1018,7 @@ static DeprecationIssue checkWatcherBulkConcurrentRequestsSetting(
             Setting.Property.NodeScope,
             Setting.Property.Deprecated
         );
-        String url = "https://ela.st/es-deprecation-8-watcher-bulk-concurrency-setting";
+        String url = "https://ela.st/es-deprecation-8-watcher-settings";
         return checkRemovedSetting(
             clusterState.metadata().settings(),
             settings,

x-pack/plugin/deprecation/src/test/java/org/elasticsearch/xpack/deprecation/DataStreamDeprecationCheckerTests.java

@@ -7,6 +7,7 @@
 
 package org.elasticsearch.xpack.deprecation;
 
+import org.elasticsearch.Version;
 import org.elasticsearch.cluster.ClusterName;
 import org.elasticsearch.cluster.ClusterState;
 import org.elasticsearch.cluster.metadata.DataStream;
@@ -56,9 +57,9 @@ public void testOldIndicesCheck() {
 
         DeprecationIssue expected = new DeprecationIssue(
             DeprecationIssue.Level.CRITICAL,
-            "Old data stream with a compatibility version < 9.0",
-            "https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-9.0.html",
-            "This data stream has backing indices that were created before Elasticsearch 9.0.0",
+            "Old data stream with a compatibility version < " + Version.CURRENT.major + ".0",
+            "https://ela.st/es-deprecation-ds-reindex",
+            "This data stream has backing indices that were created before Elasticsearch " + Version.CURRENT.major + ".0",
             false,
             ofEntries(
                 entry("reindex_required", true),
@@ -125,9 +126,9 @@ public void testOldIndicesCheckWithClosedAndOpenIndices() {
 
         DeprecationIssue expected = new DeprecationIssue(
             DeprecationIssue.Level.CRITICAL,
-            "Old data stream with a compatibility version < 9.0",
-            "https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-9.0.html",
-            "This data stream has backing indices that were created before Elasticsearch 9.0.0",
+            "Old data stream with a compatibility version < " + Version.CURRENT.major + ".0",
+            "https://ela.st/es-deprecation-ds-reindex",
+            "This data stream has backing indices that were created before Elasticsearch " + Version.CURRENT.major + ".0",
             false,
             ofEntries(
                 entry("reindex_required", true),
@@ -284,10 +285,11 @@ public void testOldIndicesIgnoredWarningCheck() {
 
         DeprecationIssue expected = new DeprecationIssue(
             DeprecationIssue.Level.WARNING,
-            "Old data stream with a compatibility version < 9.0 Have Been Ignored",
-            "https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-9.0.html",
-            "This data stream has read only backing indices that were created before Elasticsearch 9.0.0 and have been marked as "
-                + "OK to remain read-only after upgrade",
+            "Old data stream with a compatibility version < " + Version.CURRENT.major + ".0 has Been Ignored",
+            "https://ela.st/es-deprecation-ds-reindex",
+            "This data stream has read only backing indices that were created before Elasticsearch "
+                + Version.CURRENT.major
+                + ".0 and have been marked as OK to remain read-only after upgrade",
             false,
             ofEntries(
                 entry("reindex_required", false),

x-pack/plugin/deprecation/src/test/java/org/elasticsearch/xpack/deprecation/IlmPolicyDeprecationCheckerTests.java

@@ -140,7 +140,7 @@ public void testFrozenAction() {
         final DeprecationIssue expected = new DeprecationIssue(
             DeprecationIssue.Level.WARNING,
             "ILM policy [deprecated-action] contains the action 'freeze' that is deprecated and will be removed in a future version.",
-            "https://www.elastic.co/guide/en/elasticsearch/reference/master/frozen-indices.html",
+            "https://ela.st/es-deprecation-7-frozen-index",
             "This action is already a noop so it can be safely removed, because frozen indices no longer offer any advantages."
                 + " Consider cold or frozen tiers in place of frozen indices.",
             false,