Skip to content

[Backport] Fix broken documentation links in deprecation checks #36873

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

Merged
gwbrown merged 1 commit into from
Dec 20, 2018
Merged

[Backport] Fix broken documentation links in deprecation checks #36873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion ...precation/src/main/java/org/elasticsearch/xpack/deprecation/ClusterDeprecationChecks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ static DeprecationIssue checkShardLimit(ClusterState state) {
if (nodeCount > 0 && currentOpenShards >= maxShardsInCluster) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Number of open shards exceeds cluster soft limit",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_cluster_wide_shard_soft_limit",
"There are [" + currentOpenShards + "] open shards in this cluster, but the cluster is limited to [" +
shardsPerNode + "] per data node, for [" + maxShardsInCluster + "] maximum.");
}
Expand Down
7 changes: 4 additions & 3 deletions ...deprecation/src/main/java/org/elasticsearch/xpack/deprecation/IndexDeprecationChecks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ static DeprecationIssue delimitedPayloadFilterCheck(IndexMetaData indexMetaData)
}
if (issues.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING, "Use of 'delimited_payload_filter'.",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_analysis_changes.html", issues.toString());
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_literal_delimited_payload_filter_literal_renaming", issues.toString());
}
return null;
}
Expand Down Expand Up @@ -143,7 +144,7 @@ static DeprecationIssue classicSimilarityMappingCheck(IndexMetaData indexMetaDat
if (issues.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Classic similarity has been removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_the_literal_classic_literal_similarity_has_been_removed",
"Fields which use classic similarity: " + issues.toString());
}
Expand All @@ -159,7 +160,7 @@ static DeprecationIssue classicSimilaritySettingsCheck(IndexMetaData indexMetaDa
if (classicSimilarities.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Classic similarity has been removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_the_literal_classic_literal_similarity_has_been_removed",
"Custom similarities defined using classic similarity: " + classicSimilarities.toString());
}
Expand Down
20 changes: 10 additions & 10 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 @@ -32,7 +32,7 @@ static DeprecationIssue httpEnabledSettingRemoved(List<NodeInfo> nodeInfos, List
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"HTTP Enabled setting removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#remove-http-enabled",
"nodes with http.enabled set: " + nodesFound);
}
Expand All @@ -47,7 +47,7 @@ static DeprecationIssue auditLogPrefixSettingsCheck(List<NodeInfo> nodeInfos, Li
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Audit log node info settings renamed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#audit-logfile-local-node-info",
"nodes with audit log settings that have been renamed: " + nodesFound);
}
Expand All @@ -62,7 +62,7 @@ static DeprecationIssue indexThreadPoolCheck(List<NodeInfo> nodeInfos, List<Node
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Index thread pool removed in favor of combined write thread pool",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_index_thread_pool",
"nodes with index thread pool settings: " + nodesFound);
}
Expand All @@ -76,7 +76,7 @@ static DeprecationIssue bulkThreadPoolCheck(List<NodeInfo> nodeInfos, List<NodeS
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Bulk thread pool renamed to write thread pool",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#write-thread-pool-fallback",
"nodes with bulk thread pool settings: " + nodesFound);
}
Expand All @@ -91,7 +91,7 @@ static DeprecationIssue tribeNodeCheck(List<NodeInfo> nodeInfos, List<NodeStats>
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Tribe Node removed in favor of Cross Cluster Search",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_tribe_node_removed",
"nodes with tribe node settings: " + nodesFound);
}
Expand All @@ -106,7 +106,7 @@ static DeprecationIssue httpPipeliningCheck(List<NodeInfo> nodeInfos, List<NodeS
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"HTTP pipelining setting removed as pipelining is now mandatory",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#remove-http-pipelining-setting",
"nodes with http.pipelining set: " + nodesFound);
}
Expand All @@ -127,7 +127,7 @@ static DeprecationIssue discoveryConfigurationCheck(List<NodeInfo> nodeInfos, Li
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Discovery configuration is required in production mode",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_discovery_configuration_is_required_in_production",
"nodes which do not have discovery configured: " + nodesFound);
}
Expand All @@ -143,7 +143,7 @@ static DeprecationIssue azureRepositoryChanges(List<NodeInfo> nodeInfos, List<No
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Azure Repository settings changed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_azure_repository_plugin",
"nodes with repository-azure installed: " + nodesFound);
}
Expand All @@ -159,7 +159,7 @@ static DeprecationIssue gcsRepositoryChanges(List<NodeInfo> nodeInfos, List<Node
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING,
"GCS Repository settings changed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_google_cloud_storage_repository_plugin",
"nodes with repository-gcs installed: " + nodesFound);
}
Expand All @@ -175,7 +175,7 @@ static DeprecationIssue fileDiscoveryPluginRemoved(List<NodeInfo> nodeInfos, Lis
if (nodesFound.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING,
"File-based discovery is no longer a plugin and uses a different path",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_file_based_discovery_plugin",
"nodes with discovery-file installed: " + nodesFound);
}
Expand Down
3 changes: 2 additions & 1 deletion ...tion/src/test/java/org/elasticsearch/xpack/deprecation/ClusterDeprecationChecksTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ public void testCheckShardLimit() {
List<DeprecationIssue> issues = DeprecationChecks.filterChecks(CLUSTER_SETTINGS_CHECKS, c -> c.apply(state));
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Number of open shards exceeds cluster soft limit",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_cluster_wide_shard_soft_limit",
"There are [" + currentOpenShards + "] open shards in this cluster, but the cluster is limited to [" +
shardsPerNode + "] per data node, for [" + maxShardsInCluster + "] maximum.");
assertEquals(singletonList(expected), issues);
Expand Down
7 changes: 4 additions & 3 deletions ...cation/src/test/java/org/elasticsearch/xpack/deprecation/IndexDeprecationChecksTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ public void testDelimitedPayloadFilterCheck() {
.put("index.analysis.filter.my_delimited_payload_filter.encoding", "identity").build();
IndexMetaData indexMetaData = IndexMetaData.builder("test").settings(settings).numberOfShards(1).numberOfReplicas(0).build();
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING, "Use of 'delimited_payload_filter'.",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_analysis_changes.html",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_literal_delimited_payload_filter_literal_renaming",
"[The filter [my_delimited_payload_filter] is of deprecated 'delimited_payload_filter' type. "
+ "The filter type should be changed to 'delimited_payload'.]");
List<DeprecationIssue> issues = DeprecationInfoAction.filterChecks(INDEX_SETTINGS_CHECKS, c -> c.apply(indexMetaData));
Expand Down Expand Up @@ -131,7 +132,7 @@ public void testClassicSimilarityMappingCheck() throws IOException {
.build();
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Classic similarity has been removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_the_literal_classic_literal_similarity_has_been_removed",
"Fields which use classic similarity: [[type: _doc, field: classic_sim_field]]");
List<DeprecationIssue> issues = DeprecationChecks.filterChecks(INDEX_SETTINGS_CHECKS, c -> c.apply(index));
Expand All @@ -150,7 +151,7 @@ public void testClassicSimilaritySettingsCheck() {

DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Classic similarity has been removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_the_literal_classic_literal_similarity_has_been_removed",
"Custom similarities defined using classic similarity: [my_classic_similarity]");
List<DeprecationIssue> issues = DeprecationChecks.filterChecks(INDEX_SETTINGS_CHECKS, c -> c.apply(index));
Expand Down
20 changes: 10 additions & 10 deletions ...ecation/src/test/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecksTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ null, null, null, null, new FsInfo(0L, null, paths), null, null, null,
public void testHttpEnabledCheck() {
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"HTTP Enabled setting removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#remove-http-enabled",
"nodes with http.enabled set: [node_check]");
assertSettingsAndIssue("http.enabled", Boolean.toString(randomBoolean()), expected);
Expand All @@ -76,7 +76,7 @@ public void testHttpEnabledCheck() {
public void testAuditLoggingPrefixSettingsCheck() {
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Audit log node info settings renamed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#audit-logfile-local-node-info",
"nodes with audit log settings that have been renamed: [node_check]");
assertSettingsAndIssue("xpack.security.audit.logfile.prefix.emit_node_host_address", Boolean.toString(randomBoolean()), expected);
Expand All @@ -87,7 +87,7 @@ public void testAuditLoggingPrefixSettingsCheck() {
public void testIndexThreadPoolCheck() {
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Index thread pool removed in favor of combined write thread pool",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_index_thread_pool",
"nodes with index thread pool settings: [node_check]");
assertSettingsAndIssue("thread_pool.index.size", Integer.toString(randomIntBetween(1, 20000)), expected);
Expand All @@ -97,7 +97,7 @@ public void testIndexThreadPoolCheck() {
public void testBulkThreadPoolCheck() {
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Bulk thread pool renamed to write thread pool",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#write-thread-pool-fallback",
"nodes with bulk thread pool settings: [node_check]");
assertSettingsAndIssue("thread_pool.bulk.size", Integer.toString(randomIntBetween(1, 20000)), expected);
Expand All @@ -108,7 +108,7 @@ public void testTribeNodeCheck() {
String tribeSetting = "tribe." + randomAlphaOfLengthBetween(1, 20) + ".cluster.name";
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Tribe Node removed in favor of Cross Cluster Search",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_tribe_node_removed",
"nodes with tribe node settings: [node_check]");
assertSettingsAndIssue(tribeSetting, randomAlphaOfLength(5), expected);
Expand All @@ -117,7 +117,7 @@ public void testTribeNodeCheck() {
public void testHttpPipeliningCheck() {
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"HTTP pipelining setting removed as pipelining is now mandatory",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#remove-http-pipelining-setting",
"nodes with http.pipelining set: [node_check]");
assertSettingsAndIssue("http.pipelining", Boolean.toString(randomBoolean()), expected);
Expand Down Expand Up @@ -165,7 +165,7 @@ null, null, null, null, new FsInfo(0L, null, paths), null, null, null,

DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.CRITICAL,
"Discovery configuration is required in production mode",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_discovery_configuration_is_required_in_production",
"nodes which do not have discovery configured: [node_check]");
List<DeprecationIssue> issues = DeprecationChecks.filterChecks(NODE_SETTINGS_CHECKS, c -> c.apply(nodeInfos, nodeStats));
Expand All @@ -183,7 +183,7 @@ public void testAzurePluginCheck() {

DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Azure Repository settings changed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_azure_repository_plugin",
"nodes with repository-azure installed: [node_check]");
assertSettingsAndIssue("foo", "bar", expected);
Expand All @@ -198,7 +198,7 @@ public void testGCSPluginCheck() {

DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING,
"GCS Repository settings changed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_google_cloud_storage_repository_plugin",
"nodes with repository-gcs installed: [node_check]");
assertSettingsAndIssue("foo", "bar", expected);
Expand All @@ -213,7 +213,7 @@ public void testFileDiscoveryPluginCheck() {

DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING,
"File-based discovery is no longer a plugin and uses a different path",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_cluster_changes.html" +
"https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-7.0.html" +
"#_file_based_discovery_plugin",
"nodes with discovery-file installed: [node_check]");
assertSettingsAndIssue("foo", "bar", expected);
Expand Down