|
| 1 | +[[archived-settings]] |
| 2 | +== Archived settings |
| 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 |
| 8 | +unsupported index setting, {es} archives the index setting. |
| 9 | + |
| 10 | +Archived settings start with the `archived.` prefix and are ignored by {es}. |
| 11 | + |
| 12 | +[discrete] |
| 13 | +[[archived-cluster-settings]] |
| 14 | +=== Archived cluster settings |
| 15 | + |
| 16 | +After an upgrade, you can view archived cluster settings using the |
| 17 | +<<cluster-get-settings,get cluster settings API>>. |
| 18 | + |
| 19 | +[source,console] |
| 20 | +---- |
| 21 | +GET _cluster/settings?flat_settings=true&filter_path=persistent.archived* |
| 22 | +---- |
| 23 | + |
| 24 | +You can remove archived cluster settings using the |
| 25 | +<<cluster-update-settings,update cluster settings API>>. |
| 26 | + |
| 27 | +[source,console] |
| 28 | +---- |
| 29 | +PUT _cluster/settings |
| 30 | +{ |
| 31 | + "persistent": { |
| 32 | + "archived.*": null |
| 33 | + } |
| 34 | +} |
| 35 | +---- |
| 36 | + |
| 37 | +{es} doesn't archive transient cluster settings or settings in |
| 38 | +`elasticsearch.yml`. If a node includes an unsupported setting in |
| 39 | +`elasticsearch.yml`, it will return an error at startup. |
| 40 | + |
| 41 | +[discrete] |
| 42 | +[[archived-index-settings]] |
| 43 | +=== Archived index settings |
| 44 | + |
| 45 | +IMPORTANT: Before you upgrade, remove any unsupported index settings from index |
| 46 | +and component templates. {es} doesn't archive unsupported index settings in |
| 47 | +templates during an upgrade. Attempts to use a template that contains an |
| 48 | +unsupported index setting will fail and return an error. This includes automated |
| 49 | +operations, such the {ilm-init} rollover action. |
| 50 | + |
| 51 | +You can view archived settings for an index using the <<indices-get-settings,get |
| 52 | +index settings API>>. |
| 53 | + |
| 54 | +[source,console] |
| 55 | +---- |
| 56 | +GET my-index/_settings?flat_settings=true&filter_path=**.settings.archived* |
| 57 | +---- |
| 58 | +// TEST[s/^/PUT my-index\n/] |
| 59 | + |
| 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. |
| 63 | + |
| 64 | +[source,console] |
| 65 | +---- |
| 66 | +POST _reindex |
| 67 | +{ |
| 68 | + "source": { |
| 69 | + "index": "my-index" |
| 70 | + }, |
| 71 | + "dest": { |
| 72 | + "index": "reindexed-v8-my-index" |
| 73 | + } |
| 74 | +} |
| 75 | +---- |
| 76 | +// TEST[s/^/PUT my-index\n/] |
0 commit comments