Upgrading Elasticsearch

Edit online

Update an external (customer-installed) installation of Elasticsearch version 5.x or later with IBM Spectrum LSF Explorer to version 10.2 Fix Pack 9 or later. This task is not applicable if you installed the version of Elasticsearch included with Explorer.

About this task

Note: Note that some earlier versions of Elasticsearch are no longer support by Elasticsearch; refer to your Elasticsearch documentation for the version that are officially End of life (EOL).

If you are using Elasticsearch 7.17, upgrade to 8.18 by downloading and applying IBM Spectrum LSF Explorer Fix 602748 from IBM Fix Central, and follow the provided readme instructions.

Important: IBM Spectrum LSF Explorer 10.2 Fix Pack 9 and older bundled Elasticsearch versions did not support HTTPS and authentication. To use these features, install external versions of Elasticsearch 7.17 (or later, but before version 8) and migrate the data by following the Elasticsearch documentation: https://www.elastic.co/guide/en/elasticsearch/reference/7.2/restart-upgrade.html

Versions of IBM Spectrum LSF Explorer later than 10.2 Fix Pack 10 include an optional installation of Elasticsearch version 7.x. However, if you installed Elasticsearch 5.x or 6.x on your own, back it up as there are special steps for upgrading from these earlier levels.

Upgrading Elasticsearch requires a shutdown of all Explorer services. Therefore, Explorer will be out of service during this upgrade.

Procedure

Back up Elasticsearch data.

In case of a failed upgrade, back up your Elasticsearch data. A snapshot is a backup taken from a running Elasticsearch cluster. You can take a snapshot of individual indices or of the entire cluster and store it in a repository on a shared filesystem following your Elasticsearch documentation. For example:

To take a snapshot of Elasticsearch 5.4, see: https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html

To take a snapshot of Elasticsearch 6.6, see: https://www.elastic.co/guide/en/elasticsearch/reference/6.6/modules-snapshots.html

To take a snapshot of Elasticsearch 7.17, see: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/snapshot-restore.html
Upgrade Elasticsearch; refer to the version for your environment:
- To upgrade Elasticsearch from version 5.x to 6.x:
  1. Update the model index by running the following commands after setting the ES_IP and ES_PORT parameters in the commands:
```
cd explorer10.2.0.9_server_linux-x64
  ./es5Update.sh $ES_IP $ES_PORT
```
    Follow the Elasticsearch documentation to upgrade Elasticsearch to 6.x: https://www.elastic.co/guide/en/elasticsearch/reference/6.6/restart-upgrade.html
- To upgrade Elasticsearch from version 6.x to 7.x:
  1. Ensure Elasticsearch 6.x is started.
  2. Run the reindexIncompatibleIndices.sh script after setting ES_IP and ES_PORT parameters in the script.
  3. Follow the Elasticsearch documentation to upgrade Elasticsearch to 7.2.1: https://www.elastic.co/guide/en/elasticsearch/reference/7.2/restart-upgrade.html
- To upgrade Elasticsearch from version 7.17 to 8.x:
  1. Prepare to upgrade from 7.17 to 8.x, according to the Elasticsearch documentation: https://www.elastic.co/guide/en/elastic-stack/8.18/upgrading-elastic-stack.html#prepare-to-upgrade.
  2. Follow the Elasticsearch documentation to upgrade Elasticsearch from version to 8.18 : https://www.elastic.co/guide/en/elastic-stack/8.18/upgrading-elasticsearch.html.
  3. Upgrade Kibana, according to the Elasticsearch documentation: https://www.elastic.co/guide/en/elastic-stack/8.18/upgrading-kibana.html.
Optional: If Elasticsearch upgrade fails, you can reinstall your previous version of Elasticsearch and restore the data.

Refer to your Elasticsearch documentation for details. For example:

To restore Elasticsearch 5.4, see: https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html

To restore Elasticsearch 6.6, see: https://www.elastic.co/guide/en/elasticsearch/reference/6.6/modules-snapshots.html

To restore Elasticsearch 7.17, see: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/snapshot-restore.html