Elasticsearch:Upgrade check

Check for closed indexes

Run the following command to list all indexes and their statuses:

GET _cat/indices?v

The output lists each index with its status in the status column. If any index shows a close status, open it before the upgrade:

POST test/_open

Check kernel version availability

If you plan to update the cluster kernel as part of the upgrade, verify that a later kernel version is available on the Basic Information page of your cluster.

You can update the kernel only if a later version is listed.

Check client compatibility

If a client connects to the cluster, verify that its version is compatible with the target cluster version. For version compatibility details, see Compatibility. If the versions are incompatible, upgrade the client before proceeding.

Split multi-type indexes

V6.X and later do not support multi-type indexes. If the cluster has multi-type indexes, writing to those indexes still works after the upgrade, but creating new multi-type indexes in V6.X causes errors. Split each multi-type index into single-type indexes before the upgrade.

Disable cross-cluster search

Run the following command to check whether cross-cluster search is enabled:

GET _cluster/settings

If search.remote appears in the result with a non-null value, cross-cluster search is enabled. Disable it before the upgrade:

PUT _cluster/settings
{
  "persistent": {
    "search.remote.*": null
  },
  "transient": {
    "search.remote.*": null
  }
}

After the upgrade, you can re-enable cross-cluster search.

Cluster-level configurations

Disable cluster-level incompatible configurations by setting their values to null.

Snapshot settings:

PUT _cluster/settings
{
  "persistent": {
    "cluster.routing.allocation.snapshot.relocation_enabled": null
  },
  "transient": {
    "cluster.routing.allocation.snapshot.relocation_enabled": null
  }
}

Storage throttling settings:

PUT _cluster/settings
{
  "persistent": {
    "indices.store.throttle.type": null,
    "indices.store.throttle.max_bytes_per_sec": null
  },
  "transient": {
    "indices.store.throttle.type": null,
    "indices.store.throttle.max_bytes_per_sec": null
  }
}

Index-level configurations

Disable index-level incompatible configurations by setting their values to null. Replace test_index with your index name.

Similarity settings require closing the index first. Closed indexes cannot be read or written to. Reopen the index after making changes.

Close the index:

POST test_index/_close

Update the setting:

PUT test_index/_settings
{
  "index.similarity.base.*": null
}

Open the index:

POST test_index/_open

Shadow replica settings:

PUT test_index/_settings
{
  "index.shared_filesystem": null,
  "index.shadow_replicas": null
}

Index storage settings:

PUT test_index/_settings
{
  "index.store.type": null
}

Storage throttling settings:

PUT test_index/_settings
{
  "settings": {
    "index.store.throttle.type": null,
    "index.store.throttle.max_bytes_per_sec": null
  }
}

Index template-level configurations

The following example shows how to fix incompatible configurations in an index template named test_template.

1. Retrieve the current template:

   GET _template/test_template

   The result shows the incompatible configurations — in this example, index storage settings, _all, and include_in_all:

   {
     "test_template": {
       "order": 0,
       "template": "test_*",
       "settings": {
         "index": {
           "store": {
             "throttle": {
               "max_bytes_per_sec": "100m"
             }
           }
         }
       },
       "mappings": {
         "test_type": {
           "_all": {
             "enabled": true
           },
           "properties": {
             "test_field": {
               "type": "text",
               "include_in_all": true
             }
           }
         }
       },
       "aliases": {}
     }
   }

2. Remove the incompatible configurations and update the template:

   PUT _template/test_template
   {
      "order": 0,
      "template": "test_*",
      "settings": {
      },
      "mappings": {
        "test_type": {
          "properties": {
            "test_field": {
              "type": "text"
            }
          }
        }
      },
      "aliases": {}
   }