Upgrading to Zoom Server 8.x

By /

Zoom Server Upgrade from 8.0 to 8.1

The following instructions describe how to upgrade the Zoom and its related services from 8.0 to 8.1

Downtime

  • Expect server downtime. The server will not be available during upgrade.
  • Zoom server checkpointing may take a longer duration. Perform check pointing as a planned event.

Prerequisite

  • Ensure that you know the location Zoom server installation directory and the relevant Zoom services such as, Preview server and Curator Server.
  • If you are upgrading on the Linux server, do not use the root account, as it could affect permissions and they way they are set up.
  • Ensure that there are no pending or running jobs on the Archive Hub. Check the Archive or Restore jobs in the Archive Hub dashboard.

Step 1: Checkpointing the Zoom Server

Note: This step is needed only on the Zoom server.

  1. It is recommended to perform a full checkpoint before the upgrade.
  2. Please refer to Zoom Server checkpointing on restart  which explains how to checkpoint and how to verify checkpointing.
  3. Make sure you verify the checkpoint by looking at the logs.
  4. After verifying the checkpointing, make sure the Zoom server is accessible from Web Management Console.
  5. When you complete the checkpointing activity.
    1. Stop the Zoom server again.
    2. Do not start the Zoom server for users till the upgrade process is finished.

Step 2: Stop the Relevant Zoom Services

Stop all the Zoom related services

For example, stop the following services:

  • Zoom Server
  • Preview Server
  • Curator Server
  • Transcoder Server
  • Hub Server.

Step 3: Backup the Configuration files

Note: This step needs to be performed on all the Zoom related server machines.

Ensure that the following files or folders are copied to a safe location outside the Zoom installation folder.

  1. Navigate to [ZoomInstallDir]/ .
    1. For Linux Server, this is usually located at the /home/evolphin/zoom path.
    2. For Windows Server, this is usually located at the C:\Program Files (x86)\Evolphin\DAM\ path.
  2. Back up the conf directory.

Step 4: Backup the Zoom Database

While upgrading the Zoom server, you should make sure that Zoom Database is backed up and outside of the installation directory.

Note: We recommend you to move the Zoom database outside of the installation directory. If your Zoom database is still in the installation directory, copy it out to a safe location.

Inspect your server.xml file and look for db spec tags and make sure the Zoom server database is outside of the installation directory.

Here is the dbSpec snippet from server.xml:

  <dbspec>
  <defaultRoot>/mnt/zoom/db</defaultRoot>
  <redoLogDir>/mnt/zoom/db/redo</redoLogDir>
  <fileDataDir>/mnt/zoom/db/redo/filedata</fileDataDir>
  <redoBackupDir>/mnt/zoom/db-redo.bak</redoBackupDir>
  </dbspec>

Note: You do not have to do anything if it is already located outside of the installation directory.

Step 5: Backup the Curator Server Database

While upgrading the Curator server, you should make sure that Curator Server Database is backed up and outside of the installation directory.

To find the Curator Server database location, inspect the file: curator-server.xml in the conf directory of the Curator Server and look for the <solrDataDir> tag.

The value of this tag will point to the Curator Server database location. If it is inside of the installation directory, ensure that you create a backup.

For example:

  <solrDataDir>/mnt/curator-server/db/solr-db</solrDataDir>

Note: You do not have to do anything if it is already located outside of the installation directory.

Step 6: Backup the Preview Server Cache

Move the Preview Server cache outside of the installation directory.

If the preview server cache is in the installation directory, create a backup before you proceed.

To find the Preview Server cache location, inspect the preview-server.xml file of the Preview Server machine and look for the <previewCacheLocation> tag.

For example:

  <previewCacheLocation>/mnt/preview-server/cache</previewCacheLocation>

Note: You don’t have to do anything if it is already located outside of the installation directory.

Step 7: Uninstall the Services

  1. On Linux:
    1. Rename the zoom directory to zoom.<VERSION> where the “<VERSION>” is updated to the version of Zoom that is currently installed.
    2. For example, if you have v8.0 installed, rename the zoom directory as follows:
      For example: mv zoom zoom-v8.0
  2. On Windows:
    1. Open Program and Features. Uninstall the Evolphin Zoom Server app.

Step 8: Install the new version of Zoom

  1. On Linux:
    1. Untar the downloaded zoom-unix64.tar.bz2 to the installation directory. This directory is usually located in the /home/evolphin/ path.
  1. On Windows:
    1. Unzip the zoom-server-win64.zip.
    2. Execute the setup.exe from the extracted files.
    3. Follow the on-screen instructions.

Repeat Step 8 to install the new versions for the Preview, Curator, and/or Transcoder servers.

Step 9: Restore Configuration from Previous Version

Copy the files from the previously backed up “conf” directory to the newly installed “conf” directory.

For Zoom Server

  1. Copy the server.xml from backed-up conf directory to the new conf directory in  [ZoomInstallDir]/conf/.
  2. Copy metadataspec.xml from backed up conf to the new conf directory.
  3. Do not copy the hub-server.xml from backed conf dir to the new conf directory. Instead, after restarting the Zoom server, open the Hub Configuration page from the web-based Admin Console, and apply the settings present in the old hub-server.xml as appropriate. This manual step of configuration is only needed when upgrading to 8.1 from 8.0 or previous releases. Subsequent upgrades after 8.1, will not require this step.
  4. Copy the SSL certificate JKS file(s) from backed conf dir to the new conf directory. For example: webmin.jks.
  5. Copy the dynamic-forms directory from backed conf dir to the new conf directory.
    1. Note: You do not have to copy this directory if you are not using the create job forms templates.
  6. Merge client-settings/ from the backed-up conf to the new conf directory.
  7. If you have made any changes in the following files, ensure that you merge them with the new files. 
    1. old-backed-conf/
      1. thumbfiletypes.properties
      2. audiotype.properties
      3. fonttype.properties
      4. indexabletype.properties
      5. movietype.properties
      6. multipagetype.properties

Note: In most cases, these files are not modified. If you have modified these files, then perform the diff and merge steps, otherwise you can use the files from the new conf directory.

  1. Copy the memory settings.
    1. Updating the memory settings for each server is done in their respective configuration files. Typically, the allocated heap is increased for the services by editing the following lines in their respective “.conf” files.
      wrapper.java.additional.8=-Xms4g
      wrapper.java.additional.9=-Xmx4g
      (Index number 8,9 might be different for you)
    2. As part of the upgrade process, you must ensure that you are copying the old (previous) memory settings to the new “.conf” files. 
    3. For the Zoom server: 
      1. From old_conf/wrapper.conf  to new_conf/wrapper.conf
    4. For the Preview/Transcoder server: 
      1. From old_conf/preview-server.conf  to new_conf/preview-server.conf
    5. For the Curator server: 
      1. From old_conf/curator-server.conf  to new_conf/curator-server.conf
    6. For the Hotfolder running on the server machine: 
      1. From old_conf/clientproxy.conf  to new_conf/clientproxy.conf
  2. Update SSL Certificate File Name and Password for the following files:
    1. Zoom Server – wrapper.conf
    2. Preview/Transcoder Server – preview-server.conf
    3. Curator Server – curator-server.conf
  3. Copy the zoom license key file from the old conf file to new conf file.
    1. old_conf/zoom.key to new_conf/zoom.key
  4. Copy the cacerts file if any new certificates are added to default certificates. You can update the file in the [installation folder]/jre/lib/security/cacerts path.

For Preview Server

  1. Copy the preview-server.xml from backed conf dir to the new conf.
  2. Copy the  server.xml from backed up conf dir to the new conf in  [ZoomInstallDir]/conf/.
  3. Copy the SSL certificate JKS file(s) from backed conf dir to the new conf. For example: review.jks.
  4. Copy the Preview Server Memory settings and SSL cert settings from old preview-server.conf to the new preview-server.conf. See section above
  5. If you have not moved the Preview Server cache outside, we recommend you to move the Preview server cache outside of the installation directory during this upgrade. See the this article for more information: https://evolphin.com/help/administration-server/configuration-server/configuring-preview-server/
  6. Make sure the preview cache location in the preview-server.xml points to the correct and valid location.
  7. Copy the server-settings folder from the backed up preview server configuration directory to the new conf.
  8. Copy the cacerts file if any new certificates are added to default certificates. You can update the file in the [installation folder]/jre/lib/security/cacerts path.

For Curator Server

  1. Copy the curator-server.xml from the backed-up conf dir to the new conf.
  2. If you have not moved the Solr Server Database outside of the installation, it is recommended that you to move it during this upgrade.
  3. Make sure the Solr database the curator-server.xml point to the correct and valid location.
  4. Copy the Curator Server Memory settings and SSL cert settings from the old curator-server.conf to the new preview-server.conf. See section above 

Step 10: Start and Verify the Services

Start the Zoom server

  • On Linux: service zoom start (ensure that this is run with a non-root user).
  • On Windows: Use service manager.
  • Check the Zoom server logs. See if the Zoom server has started properly and ensure that there is no error.
  • Open the Zoom Web management console and add your new license key if you have one.
  • Verify the users and other settings in the Web management console.

Start the Preview Server

  • On Linux: service preview-server start (ensure that this is run with a non-root user).
  • On Windows: Use service manager.
  • Check the Preview server logs. See if the server has started properly and ensure that there are no errors.
  • Login to the Webclient and verify if the user is able to perform basic operations. For example: upload an asset, preview an asset, download and asset, and so on.

Start the Curator Server

  • On Linux: service curator-server start (ensure that this is run with a non-root user).
  • On Windows: Use service manager.
  • Check the Curator server logs. See if the server has started properly and ensure that there are no errors.
  • Login to the Zoom Server Web Management Console and verify if the server is able to connect to the Curator dashboard and view the indexing status.

Evolphin Job Hub 8.0 to 8.1 Upgrade

Prerequisite

  • Make sure you know the installation location of Evolphin Job Hub.
  • If you are upgrading on the Linux server, do not use the root account, it could affect permissions.
  • Important: Make sure there are no pending or running jobs on the Hub. Check the Archive or Restore jobs in the Archive Hub dashboard.
  • You can upgrade the Hub if AI jobs are running.

Step 1: Stop the Hub Service

  • Locate the Hub Server installation directory.
  • Go to the bin directory.
  • On Linux:
    • Run: ./hub status to check if hub is running.
    • Run: ./hub stop to stop the server.
  • On Window
    • Use the service manager to check hub status, start or stop the hub service. (Look for default service name “Evolphin Job Hub”).

Step 2: Uninstall the Old Hub

  • Rename the existing Hub installation directory: ejh to ejh.<VERSION>. Where “<VERSION>” is replaced with the Hub version number, for the version you are trying to uninstall.
  • For example:
    • Rename ejh → ejh.8.0

Step 3: Copy the new Hub build

  • On Linux, untar the hub build file at the same place where the old hub was installed.
  • On Windows, unzip the hub build file at the same place where the old hub was installed.

Step 4: Config changes required for Hub Upgrade

Changes on Zoom Server/Webmin

  • Keep the backup of the existing Hub-server.xml from Step 2 ready.
  • Use new hub-server.xml which comes with installation, and populate the fields manually from backup hub-server.xml in Webmin.
  • Save the settings.

Hub Server

  • Keep the backup of existing hub.xml and hubServer.jks files.
  • Ensure that the zoom-deploy path is present and the owner that is specified here, is the owner using the hub service that is running.
    • If this path is not present, then start the hub once. This will cause the zoom-deploy path to get created. Confirm that it is created, and then shut down hub again. Proceed with the steps below after that.

Note: If the hub fails to start, then check the following:

JAVA_HOME environment variable may be missing. Add this entry to point to the JRE installation path.

On Windows
wrapper.java.command=C:\Program Files (x86)\Evolphin\DAM\jre\bin\java
On Linux
wrapper.java.command=/home/evolphin/zoom/jre/bin/java

  • Populate the fields in the hub.xml file present at the zoom-deploy path from the backup hub.xml.

Note: The field named “hubName” in the 8.0 hub, has been renamed to “location” in 8.1.

Step 6: Edit Veritone AI API Version

Note: Perform this step if you are using Veritone AI provider on this Hub.

  1. The New version of the Hub uses Veritone V3 APIs to communicate with Veritone engines. You need to enable version 3 in the ai-spec.xml.
  2. Open the ai-spec.xml file.
  3. Locate the section: <VeritoneSpec>
  4. Add the following line the <VeritoneSpec> section:
    • <veritoneApiVersion>v3</veritoneApiVersion>
  5. Save the file.

Step 5: Start the Hub Service

  • On Linux:
    • Run: ./hub start to start the service.
    • Run: ./hub status to check the status.
  • On Windows:
    • Use the service manager to start the service and check the status.

Step 6: Check the Hub Server Logs

Check the Hub Server logs and see if the logs have started running.