1
1
[[archived-settings]]
2
2
== Archived settings
3
3
4
- {es} typically removes support for deprecated settings at major version
5
- releases. If you upgrade a cluster with a deprecated persistent cluster setting
6
- to a version that no longer supports the setting, {es} automatically archives
7
- that setting. Similarly, if you upgrade a cluster that contains an index with an
4
+ If you upgrade a cluster with a deprecated persistent cluster setting to a
5
+ version that no longer supports the setting, {es} automatically archives that
6
+ setting. Similarly, if you upgrade a cluster that contains an index with an
8
7
unsupported index setting, {es} archives the index setting.
9
8
10
- Archived settings start with the `archived.` prefix and are ignored by {es}.
9
+ We recommend you remove any archived settings after upgrading. Archived
10
+ settings are considered invalid and can interfere with your ability to configure
11
+ other settings.
12
+
13
+ Archived settings start with the `archived.` prefix.
11
14
12
15
[discrete]
13
16
[[archived-cluster-settings]]
14
17
=== Archived cluster settings
15
18
16
- After an upgrade, you can view archived cluster settings using the
17
- <<cluster-get-settings,cluster get settings API>>.
19
+ Use the following <<cluster-update-settings,cluster update settings>> request to
20
+ check for archived cluster settings. If the request returns an empty object
21
+ (`{ }`), there are no archived cluster settings.
18
22
19
23
[source,console]
20
24
----
21
25
GET _cluster/settings?flat_settings=true&filter_path=persistent.archived*
22
26
----
23
27
24
- You can remove archived cluster settings using the
25
- <<cluster-update-settings,cluster update settings API>> .
28
+ To remove any archived cluster settings, use the following
29
+ <<cluster-update-settings,cluster update settings>> request .
26
30
27
31
[source,console]
28
32
----
@@ -48,18 +52,23 @@ templates during an upgrade. Attempts to use a template that contains an
48
52
unsupported index setting will fail and return an error. This includes automated
49
53
operations, such the {ilm-init} rollover action.
50
54
51
- You can view archived settings for an index using the <<indices-get-settings,get
52
- index settings API>>.
55
+ Archived index settings don't affect an index's configuration or most index
56
+ operations, such as indexing or search. However, you'll need to remove them
57
+ before you can configure other settings for the index, such as `index.hidden`.
58
+
59
+ Use the following <<indices-get-settings,get index settings>> request to get a
60
+ list indices with archived settings. If the request returns an empty object
61
+ (`{ }`), there are no archived index settings.
53
62
54
63
[source,console]
55
64
----
56
- GET my-index /_settings?flat_settings=true&filter_path=**.settings.archived*
65
+ GET * /_settings?flat_settings=true&filter_path=**.settings.archived*
57
66
----
58
67
// TEST[s/^/PUT my-index\n/]
59
68
60
- Removing archived index settings requires a reindex after the upgrade. However,
61
- reindexing can be resource intensive. Because {es} ignores archived settings,
62
- you can safely leave them in place if wanted .
69
+ Removing an index's archived index settings requires a <<docs- reindex,reindex>>.
70
+ Reindexing can be resource- intensive and time-consuming. Before you start, test
71
+ the reindex with a subset of the data to estimate your time requirements .
63
72
64
73
[source,console]
65
74
----
@@ -69,7 +78,7 @@ POST _reindex
69
78
"index": "my-index"
70
79
},
71
80
"dest": {
72
- "index": "reindexed-v8- my-index"
81
+ "index": "reindexed-my-index"
73
82
}
74
83
}
75
84
----
0 commit comments