Upgrade Platform Container

Upgrade Platform Container

Important!

It is essential to review and potentially adjust your Java memory settings, especially prior to an upgrade process as it demands additional resources for memory heap, pico timeout and Metaspace size. See Java Configuration and Managing Picos with Topo .

Important!

When upgrading to this release, the  install.admin.password must be set according to your current admin password before proceeding with the ./setup.sh upgrade step.

Important!

If the existing installation has additional JVM arguments configured which are obsolete in Java 17, remove them and update to use supported options.

Please refer to https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#obsolete-java-options for details on ‘Obsolete’ and ‘Removed’ Java options since Java 8.

See Managing Picos with Topo for JVM Arguments configuration.

  1. Enter the release content directory that was created when you extracted the delivered *.tgz file during the Upgrade Preparations.

  2. Pre-upgrade validations are performed to verify the environment and configuration, ensuring a seamless upgrade experience. To perform validation without starting the upgrade, run the following command:

    ./setup.sh upgrade -validate-only
  3. Run the following command to initiate the upgrade process:

    ./setup.sh upgrade

    When using the ./setup.sh upgrade command, setup log file will be generated in the $MZ_HOME/log directory.

Hint!

It may be a good idea to open a new command line window in order to keep track of the log files.

Note!

If the upgrade validation fails, there is no need to perform a rollback or restore, as the upgrade process has not yet begun.

  1. If validation fails but you choose to proceed, you can run the following command:

    ./setup.sh upgrade -skip-validate

Caution!

You can choose to skip validation, but be aware that this bypasses checks for potential issues in your environment and configuration. If there are undetected problems, the upgrade may fail or cause unexpected behavior. Proceed with caution and ensure you have backups before continuing.

  1. Startup the platform.

    mzsh startup platform
  2. Start the pico for the User Interface.

    mzsh startup ui
  3. If you wish to change the port number, execute the following command:

    mzsh topo set topo://container:<platform-container>/pico:ui/val:config.properties.ui.webserver.port <port-number>

Note!

If your upgrade fails, you can perform a rollback using the MZ_HOME backup, see Simplified Downgrade Procedure.

Hint!

If any configurations have become invalid due to the upgrade, these will be listed in the log file. Search for the string "Regenerating configs" in the log file to find information about any invalid configurations.

Example - Output in the upgrade_<timestamp>.log file with invalid configurations.

Mon Nov 19 10:52:10 CET 2013 Regenerating configs The following configurations changed status and may require manual attention: Workflow Test.WF1 became invalid, Workflow Test.WF2 became invalid, APL Code Test.apl_profile became invalid,