Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 99 Next »

During the upgrade process, you must use the default application user, mzadmin, and correct password whenever you are prompted to enter it.

The preparation steps will not affect the running system and can be done in advance.

Note!

For users who have custom agents created in Development Toolkit:

If you have custom agents created using Development Toolkit, these agents cannot be included in the upgrade. For information on how to remove them before proceeding with the upgrade procedure, see Upgrade and Downgrade in Installation and Setup in Development Toolkit User's Guide. 

Note!

For systems using Configuration Spaces:

Configuration Spaces is replaced with the new Workflow Packages functionality. Prior to upgrading make sure to export the configuration from inactive configuration spaces that you want to keep, as only the active space is carried across during the upgrade process.

For further information regarding Configuration Spaces, and how to use them, see Configuration Spaces in the  8.3 documentation.

Before proceeding with the upgrade, make the following preparations:

  1. Verify that you are running version 8.3.x. You can check the current version by opening the About window in the Desktop, where the current version is listed in the Pico Version section. If the system is running an earlier version, you need to upgrade it to an 8.3.x version first. See the documentation space for the version you are currently running for more information.
      
  2. Install either Oracle JDK 17 or OpenJDK 17 on the server(s) where the Platform Container and Execution Containers are running.

  3. Verify that the System Requirements are met. If the operating system, or database need to be upgraded, this should be done prior to the upgrade. This has to be done for all machines that are hosting the system.

  4. Ensure that the environment variables are set correctly:

    VariableDescription
    MZ_HOME
    This environment variable specifies where the software is installed.

    Note!

    You should use an absolute path instead of a symlink for the MZ_HOME directory to avoid any issue during installation or upgrade.

    JAVA_HOMEThis environment variable specifies where the JDK is installed.
    PATHThis environment variable specifies the search path and must contain the following directories: $JAVA_HOME/bin:$MZ_HOME/bin

    Example - Setting environment variables

    $ export MZ_HOME=/opt/mz 
$ export JAVA_HOME=/opt/jdk-17.0.4.1
$ export PATH=$JAVA_HOME/bin:$MZ_HOME/bin:$PATH

  5. Make a backup of all your configurations with System Export. This can be done either in Desktop, which is described in System Exporter or by using the mzsh systemexport command:

    $ mzsh mzadmin/<password> systemexport <backup directory>/<filename>

    Use of System Export File

    The exported configurations might be needed in order to be able to perform a system restore.

  6. Make an online backup of the database(s). For further information regarding how to perform an online backup, see Backup and Disaster Recovery Procedures.

    Note!

    If you are upgrading from 8.3.x, you can find the database backup instructions in the documentation for 8.3 as the procedure may differ from that of 9.x.

  7. If you are upgrading from 8.3.x, it is important to make a backup of MZ_HOME for system restore in case of upgrade failure.

    To make a backup of your MZ_HOME, you can use the following command:

    Note!

    Ensure that you have shutdown your platform and all executions prior to the backup.

    $ cd $MZ_HOME/../
$ tar -zcvf mzhome_backup.tgz <MZ_HOME directory>
$ mv mzhome_backup.tgz <backup directory>

    Use of MZ_HOME backup

    The MZ_HOME backup might be needed in order to be able to perform a system restore in case upgrade failure.

    Use of Filebase persistence

    When you have the platform property mz.userserver.filebased set to true, to ensure a seamless upgrade process, it is imperative to export all the config before the upgrade and re-import it afterward. Failure to do so may result in the missing configuration data in the upgrade.

  8. If you are performing an upgrade of a system with large configurations, you may need to increase the maximum number of file descriptors.

    Example - Changing the maximum number of file descriptors on Linux


    $ cat /proc/sys/fs/file-max
5000 
$ su - root 
Password: 
$sysctl -w fs.file-max=100000


  9. Create a directory to use when unpacking this release and future releases. For the purpose of these instructions, this designated directory is referred to as the staging directory.

    Note!

    The staging directory should not be the same directory as the one you created and set up as the MZ_HOME directory.

  10. Place the *.tgz file from your release delivery into the staging directory.

  11. Use a command line tool, go to the staging directory, and unpack the *.tgz file by running the following command:

    $ tar xvzf <filename>.tgz

    A directory is then created in the staging directory, containing the software to be installed. For the purpose of these instructions, this directory is referred to as the release content directory.

  12. Copy the MZ license file into the release content directory. 

    If you are upgrading from 8.3.x, you need a new license file . Contact DigitalRoute Support on getting the MZ license file.

    $ cp mz.license <release content directory>

    Example - Copy the mz.license file into installation folder


    $ cp mz.license DR_Internal_9.0.1.0_demo_all_20230616-041603/

  13. Enter the release content directory and prepare the install.xml file by running the following command:

    $ cd <release content directory>
$ ./setup.sh prepare

    The *.mzp packages have now been extracted, and the install.xml has been extracted into the release content directory.

    Note!

    Refer Updating the Installation Properties for Platform to know more about these properties and their default values.


  14. Important!

    When upgrading to 9.x, 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 Java 17 docs for details on 'Obsolete' and 'Removed' Java options since Java 8.

    Refers to Managing Picos with Topo for JVM Arguments configuration.

    Note!

    When upgrading to 9.x, the install.security property (in install.xml) is automatically set to true. If you prefer to disable this setting, it must be manually changed to false. 

    If install.security was set to false before the upgrade and is set to true after or during the upgrade, you need to change the url in the desktop launcher from http to https.

  15. Important!

    If your existing MZ_HOME platform database is configured to use other database type rather than the default Derby, you need to check and update the respective database related properties from the install.xml file to match your current setup.

    Oracle

    The following properties require manual update:

    <property name="install.ora.jdbc.user" value="mzadmin"/>
    <property name="install.ora.jdbc.password" value="mz"/>

    <property name="install.ora.owner" value="mzowner"/>
    <property name="install.ora.password" value="mz"/>
    <property name="install.ora.host" value="localhost"/>
    <property name="install.ora.size" value="small"/>
    <property name="install.ora.port" value="1521"/>
    <property name="install.ora.home" value="/opt/oracle"/>
    <property name="install.ora.sid" value="MZ"/>

    See Properties for Oracle for details.

    PostgreSQL

    The following properties require manual update:

    <property name="install.pg.owner" value="mzowner"/>
    <property name="install.pg.password" value="mz"/>

    See Properties for PostgreSQL for details.

    SAP HANA

    See Properties for SAP HANA for details.

    Important Note on Database 3pp Before Upgrading!

    If you are upgrading from 9.0.0.0, 9.0.1.0 or 9.1.0.0, check to see if the database 3pp jar is in the $MZ_HOME/3pp folder.

    If it does not exist in the $MZ_HOME/3pp folder, then you need to manually copy the database 3pp jar to the $MZ_HOME/3pp folder prior to the upgrade.

    This step is NOT required if your current running version is 9.0.2.0 or 9.1.2.0 onwards.

    Note on Oracle ojdbc.jars!

    If you are upgrading from 8.x and using Oracle as the system database, you need to use Oracle 19c (19.20.0.0) JDBC drivers (ojdbc8.jar/ojdbc10.jar).

    Replace the jar files in $MZ_HOME/3pp and $MZ_HOME/lib folders

    The jar file can be downloaded from https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html

  • No labels