Skip to content

Upgrade Helper


The upgrade_helper.js script offers a partial automation of data migration when the upgrading to the next major version of SEAL Elastic Stack.

It checks whether an Elasticsearch cluster is ready for an upgrade to the next major version. It checks:

  • cluster health

  • Elasticsearch version compatibility

  • Upgrade Assistant warnings

  • system-index migration requirements

  • incompatible indices

  • incompatible data streams.

The script uses the Elasticsearch and Kibana REST APIs.

Hint - Node.js version

The scritpt requires Node.js 18 or later.


Instructions

  1. Change to the prepare_upgrade directory:

    cd "SEAL Elastic Stack - 8.19.24.551 - rpm/server/prepare_upgrade"
    
  2. Start Upgrade Helper with the -dryrun option:

    /opt/seal/seal-kibana/node/glibc-217/bin/node ./upgrade_helper.js -dryrun
    
  3. Review rollovers, index cleanup, and indices that need re-indexing.

  4. Start Upgrade Helper without the -dryrun option:

    /opt/seal/seal-kibana/node/glibc-217/bin/node ./upgrade_helper.js
    

    For available options, see Elasticsearch Upgrade Helper - Usage

    Hint - patience required

    It may take some time until the re-indexing process is finished.

  5. In a browser, Start Elastic Upgrade Assistant and follow the instructions:

    http://localhost:5601/app/management/stack/upgrade_assistant/overview
    
  6. In Elastic Upgrade Assistant, complete any reported data-stream or system-index actions.

  7. Start Upgrade Helper again, until any upgrade warnings are eliminated.


Back to top