Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation URLs #125089

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from
Draft

Update Documentation URLs #125089

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
02d669c
ES-9508 Update Data Steam Deprecation notice text and URL
lukewhiting Mar 13, 2025
54f760a
ES-9508 ILM Policy deprecation checker URL to short URL
lukewhiting Mar 13, 2025
99fa87c
ES-9508 Index version deprecation notices
lukewhiting Mar 17, 2025
19ef1de
ES-9508 Translog Retention Deprecation URL
lukewhiting Mar 17, 2025
838a748
ES-9508 Index data path deprecation URL
lukewhiting Mar 17, 2025
936495e
ES-9508 Simplefs deprecation
lukewhiting Mar 17, 2025
32ceffb
ES-9508 Datafeed deprecated options notice
lukewhiting Mar 17, 2025
38684b4
ES-9508 Datafeed deprecated aggregation options notice
lukewhiting Mar 17, 2025
4401764
ES-9508 Model snapshot version deprecation notice
lukewhiting Mar 17, 2025
34e8d38
ES-9508 Shared data path setting deprecation
lukewhiting Mar 17, 2025
466a44a
ES-9508 Realm prefix deprecation
lukewhiting Mar 17, 2025
5ef8149
ES-9508 eql enable deprecation
lukewhiting Mar 17, 2025
5570a09
ES-9508 Watcher setting deprecation
lukewhiting Mar 17, 2025
848c260
ES-9508 Formatting changes
lukewhiting Mar 17, 2025
5de3af8
Update x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpac…
lukewhiting Mar 19, 2025
9e31f85
Update x-pack/plugin/deprecation/src/test/java/org/elasticsearch/xpac…
lukewhiting Mar 19, 2025
3a9b95b
Merge branch 'main' of github.com:elastic/elasticsearch into es-9508-…
lukewhiting Mar 19, 2025
ccc0769
Merge branch 'main' of github.com:elastic/elasticsearch into es-9508-…
lukewhiting Mar 19, 2025
284b0e7
ES-9508 Update index and data stream deprecation notices to be backpo…
lukewhiting Mar 20, 2025
779a235
Merge branch 'main' of github.com:elastic/elasticsearch into es-9508-…
lukewhiting Mar 20, 2025
d18a30e
[CI] Auto commit changes from spotless
elasticsearchmachine Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions ...ation/src/main/java/org/elasticsearch/xpack/deprecation/DataStreamDeprecationChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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.0",
"https://ela.st/es-deprecation-ds-reindex",
"This data stream has backing indices that were created before Elasticsearch " + Version.CURRENT.major + "0.0",
false,
ofEntries(
entry("reindex_required", true),
Expand All @@ -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.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.0 and have been marked as OK to remain read-only after upgrade",
false,
ofEntries(
entry("reindex_required", false),
Expand Down
2 changes: 1 addition & 1 deletion ...cation/src/main/java/org/elasticsearch/xpack/deprecation/IlmPolicyDeprecationChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
17 changes: 7 additions & 10 deletions ...eprecation/src/main/java/org/elasticsearch/xpack/deprecation/IndexDeprecationChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,7 @@ private DeprecationIssue oldIndicesCheck(
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",
"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 "
+ "configured to write to this index: [%s]. Refer to the migration guide to learn more about how to prepare "
Expand All @@ -117,7 +116,7 @@ private DeprecationIssue oldIndicesCheck(
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",
"https://ela.st/es-deprecation-9-index-version",
"This index has version: " + currentCompatibilityVersion.toReleaseVersion(),
false,
Map.of("reindex_required", true)
Expand All @@ -144,8 +143,7 @@ private DeprecationIssue ignoredOldIndicesCheck(
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",
"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 "
+ "transforms are no longer able to write to this index: [%s]. Refer to the migration guide to learn more "
Expand All @@ -160,7 +158,7 @@ private DeprecationIssue ignoredOldIndicesCheck(
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",
"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",
Expand Down Expand Up @@ -196,7 +194,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,
Expand All @@ -214,8 +212,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);
}
Expand All @@ -232,7 +229,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].",
Expand Down
7 changes: 3 additions & 4 deletions ...n/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/MlDeprecationChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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())
Expand Down
9 changes: 4 additions & 5 deletions .../deprecation/src/main/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down Expand Up @@ -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 "
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
22 changes: 12 additions & 10 deletions .../src/test/java/org/elasticsearch/xpack/deprecation/DataStreamDeprecationCheckerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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.0",
"https://ela.st/es-deprecation-ds-reindex",
"This data stream has backing indices that were created before Elasticsearch " + Version.CURRENT.major + "0.0",
false,
ofEntries(
entry("reindex_required", true),
Expand Down Expand Up @@ -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.0",
"https://ela.st/es-deprecation-ds-reindex",
"This data stream has backing indices that were created before Elasticsearch " + Version.CURRENT.major + "0.0",
false,
ofEntries(
entry("reindex_required", true),
Expand Down Expand Up @@ -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.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.0 and have been marked as OK to remain read-only after upgrade",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: When we check the lucene compatibility for indices we hardcode version 9.0.0 but when we check it for data streams it's not version specific. I am wondering why we have different approaches in these two cases; I initially expected them to be treated in the same way.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it's mostly a choice on my part... We own the DS check so I felt comfortable improving it but not the index one so I didn't want to go messing with the logic there too much, especially as I'm not sure what Kibana does with those messages and if it tries to parse them.

Might be being a little over cautious so happy to go back and give the index check the same treatment or, to roll this one back so it's hard coded the same as the main index check.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, I think we own both so if this is stopping you then I understand. I think Kibana should be ok, I do not think it parses the messages, if you have time we could double check it with them; otherwise, we can leave it as it is.

Copy link
Contributor Author

@lukewhiting lukewhiting Mar 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahhh good stuff. I thought core owned the index deprecation notices so avoided it... Anyway I have updated those to now use a dynamic version number but was careful to make sure the messages didn't actually change their content to sidestep any kibana issues.

false,
ofEntries(
entry("reindex_required", false),
Expand Down
2 changes: 1 addition & 1 deletion ...n/src/test/java/org/elasticsearch/xpack/deprecation/IlmPolicyDeprecationCheckerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Loading
Loading