tencent cloud

Different versions of Elasticsearch have certain incompatible configuration items, and if you have set such items, an upgrade may affect the use of your cluster. You can use the upgrade check feature to check whether there are any incompatible configuration items and adjust them accordingly. The following describes the check to be performed when upgrading the Elasticsearch version.

On the details page in the console, click Upgrade in the top-right corner. For detailed directions, please see Upgrading ES Clusters.

Configuration Check for Elasticsearch Upgrade from 5.x to 6.x

Checklist of configuration items

• WARNING: upgrade can still be performed even if the check fails. The settings for this type of check items will be ignored after the upgrade.
• CRITICAL: upgrade cannot be performed if the check fails. The settings for this type of check items are incompatible in the target version.

How to adjust incompatible configuration items

Cluster level

• Snapshot settings
  You can cancel these settings (including persistent and transient) through the ES cluster settings update API (PUT _cluster/settings):

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

• Store throttling settings
  You can cancel these settings (including persistent and transient) through the ES cluster settings update API (PUT _cluster/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

• Similarity settings
  These settings will be ignored after upgrade to 6.x, which will not affect the upgrade though. To cancel them, follow the steps below:
  • The index needs to be closed before you modify these settings, and the closed index cannot be read or written. Close the index:

    POST my_index/_close

  • Cancel these settings through the ES index settings update API:

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

  • Then, open the index by running the following command:

    POST my_index/_open

• Shadow replicas settings
  • The index needs to be closed before you modify these settings, and the closed index cannot be read or written. Close the index:

    POST my_index/_close

  • Cancel these settings through the ES index settings update API:

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

  • Then, open the index by running the following command:

    POST my_index/_open

• Index store settings
  • The index needs to be closed before you modify these settings, and the closed index cannot be read or written. Close the index:

    POST my_index/_close

  • Cancel these settings through the ES index settings update API:

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

  • Then, open the index by running the following command:

    POST my_index/_open

• Index store throttling settings
  Cancel these settings through the ES index settings update API:

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

• The include_in_all index mapping parameter
  A previously created index containing this parameter is compatible after the upgrade and does not need to be repaired.

Index template level

1. Use the GET _template/my_template API to get the incompatible template my_template. There are three incompatible items: index store settings, index template mapping parameter (include_in_all), and index template mapping metafield (_all).

   {
    "my_template": {
      "order": 0,
      "template": "my_*",
      "settings": {
        "index": {
          "store": {
            "throttle": {
              "max_bytes_per_sec": "10m"
            }
          }
        }
      },
      "mappings": {
        "my_type": {
          "_all": {
            "enabled": true
          },
          "properties": {
            "my_field": {
              "type": "text",
              "include_in_all": true
            }
          }
        }
      },
      "aliases": {}
    }
   }

2. After copying and removing incompatible configuration items from the template, use the PUT _template/my_template API to update the template.

   PUT _template/my_template
   {
      "order": 0,
      "template": "my_*",
      "settings": {
      },
      "mappings": {
        "my_type": {
          "properties": {
            "my_field": {
              "type": "text"
            }
          }
        }
      },
      "aliases": {}
   }