Skip to content

Commit c023f67

Browse files
authored
Add migration note for remote cluster settings (#33632)
The remote cluster settings search.remote.* have been renamed to cluster.remote.* and are automatically upgraded in the cluster state on gateway recovery, and on put. This commit adds a note to the migration docs for these changes.
1 parent 901d803 commit c023f67

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

docs/reference/migration/migrate_7_0/settings.asciidoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,16 @@ will be removed in the future, thus requiring HTTP to always be enabled.
4040
This setting has been removed, as disabling http pipelining support on the server
4141
provided little value. The setting `http.pipelining.max_events` can still be used to
4242
limit the number of pipelined requests in-flight.
43+
44+
==== Cross-cluster search settings renamed
45+
46+
The cross-cluster search remote cluster connection infrastructure is also used
47+
in cross-cluster replication. This means that the setting names
48+
`search.remote.*` used for configuring cross-cluster search belie the fact that
49+
they also apply to other situations where a connection to a remote cluster as
50+
used. Therefore, these settings have been renamed from `search.remote.*` to
51+
`cluster.remote.*`. For backwards compatibility purposes, we will fallback to
52+
`search.remote.*` if `cluster.remote.*` is not set. For any such settings stored
53+
in the cluster state, or set on dynamic settings updates, we will automatically
54+
upgrade the setting from `search.remote.*` to `cluster.remote.*`. The fallback
55+
settings will be removed in 8.0.0.

server/src/main/java/org/elasticsearch/transport/RemoteClusterAware.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@
5252
*/
5353
public abstract class RemoteClusterAware extends AbstractComponent {
5454

55+
static {
56+
// remove search.remote.* settings in 8.0.0
57+
assert Version.CURRENT.major < 8;
58+
}
59+
5560
public static final Setting.AffixSetting<List<String>> SEARCH_REMOTE_CLUSTERS_SEEDS =
5661
Setting.affixKeySetting(
5762
"search.remote.",

server/src/main/java/org/elasticsearch/transport/RemoteClusterService.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@
6666
*/
6767
public final class RemoteClusterService extends RemoteClusterAware implements Closeable {
6868

69+
static {
70+
// remove search.remote.* settings in 8.0.0
71+
assert Version.CURRENT.major < 8;
72+
}
73+
6974
public static final Setting<Integer> SEARCH_REMOTE_CONNECTIONS_PER_CLUSTER =
7075
Setting.intSetting("search.remote.connections_per_cluster", 3, 1, Setting.Property.NodeScope, Setting.Property.Deprecated);
7176

0 commit comments

Comments
 (0)