Upgrading a CTERA Portal

Updated
  • 4 minute(s) read
Prev Next

The procedure to upgrade an existing CTERA Portal installation is dependent on whether the upgrade involves upgrading the portal software or both the portal image and the software.

As a general rule, new releases include both image and software upgrades and CTERA strongly recommends that you upgrade both. The release notes for each release specifies whether a portal image upgrade is required in addition to a portal software upgrade.

You upgrade both the portal image and the software (Upgrading the Portal Image and Software) or just the software via CLI (Upgrading the Portal Software).

CTERA strongly recommends upgrading the portal image and software with the help of CTERA Support.

Make sure that the required ports are open, as described in Port Requirements.

Upgrading the Portal Image and Software

You have to shutdown all the portal servers before upgrading the image.

Note

Customers without Internet access and upgrading a CentOS 7 Portal image that has not previously installed packages for syslog functionality, require manually installing packages for syslog functionality for offline servers:

  1. Upgrade the portal image with the latest image file, but do not run the setup wizard.
  2. Copy the archive file, exported_images.tar.gz, from the Download Center, to a local folder on the portal machine.
  3. Run the following CLI command on all servers (including main, Replica, DB, and Preview servers): portal-syslog-client load_images images_archive_path
    where images_archive_path is the path to the local folder where you copied the archive file.
  4. Run the setup wizard.
    If the setup wizard was run prior to loading the new packages, you must rerun the CLI portal-syslog-client load_images images_archive_path and then restart all servers.
    If you do not run the CLI command, the syslog functionality will not work and an error message is generated. However, if you do not run the CLI command, apart from the error message, there is no impact on portals where syslog functionality is not used.

To upgrade the CTERA Portal image and software:

  1. Shutdown all the portal servers.
    First stop all application and preview servers. Next stop the main database server and finally stop the replication database server.
    1. Using SSH, log in as root to each CTERA Portal server.
    2. Run the following command: portal-manage.sh stop
      When the server has stopped, the Done message is displayed on the screen.
  2. When all servers are in a stop state, upgrade the portal image on each server.
    First upgrade and start the main database server. Next upgrade and restart all application and preview servers. Finally, upgrade and restart the replication database server.
    You restart each server using the command portal-manage.sh start
    1. Using SSH, log in as root to the CTERA Portal server.
    2. Copy the upgrade zip file to the machine.
    3. Navigate to the location of the zip file and run the following command to extract the portal image file: tar xvf file where file is the zip file.
      Notes

      CentOS 7: file has the format: portal-installer-linux-x.y.z.tar.bz2 where x.y.z is the version number.

      CentOS 9: file is the filename. The file contains the rpm packages for the image.

    4. Navigate to the directory where the unzipped file is and run the following command:
      CentOS 7 servers, run: ./install.sh –u
      CentOS 9 servers, run: chmod +x rpm_upgrade.sh && ./rpm_upgrade.sh

When upgrading a CentOS 9 portal, patch upgrades are relatively quick as only the packages that have changed are updated. An upgrade to the next major version takes more time.

Notes

You can also check that the upgrade has succeeded by running portal-manage.sh status which displays the image version and service, software, version.

When the release notes specify that the image upgrade also involves a kernel upgrade, an additional restart is also required to complete the kernel upgrade, after restarting each server.

  1. Stop the portal: portal-manage.sh stop
  2. Start the portal: portal-manage.sh start

Upgrading the Portal Software

You can upgrade the portal software in the CTERA Portal user interface, or via the command line.

Note

Normally, you upgrade the portal image, which includes upgrading the software.

To upgrade the CTERA Portal software via the portal user interface:

Warning

You must contact CTERA Support before using the UI to upgrade the portal software.

To upgrade the CTERA Portal software via CLI:

  1. Stop the portal servers.
    First stop all application and preview servers. Next stop the main database server and finally stop the replication database server, if available.
    1. Using SSH, log in as root to the CTERA Portal server.
    2. Run the following command: portal-manage.sh stop
      Once services are stopped, the Done message is displayed on the screen.
  2. When all servers are in a stop state, upgrade the primary database portal software.
    1. Using SSH, log in as root to the CTERA Portal server.
    2. Upgrade the portal software: portal-manage.sh upgrade upgrade_file
      where upgrade_file is the software file provided by CTERA.
  3. Restart the primary database server: portal-manage.sh start
  4. After the primary database server is running, using SSH, log in as root to the other CTERA Portal servers.
    1. Upgrade the portal software on each CTERA Portal server: portal-manage.sh upgrade upgrade_file
      where upgrade_file is the software file provided by CTERA.
    2. Restart the CTERA Portal servers.
      First start the replication database server, if available. Next, start the application and preview servers.
      1. Using SSH, log in as root to the CTERA Portal server.
      2. Start the CTERA Portal: portal-manage.sh start
Related articles
Copyright © CTERA Networks Ltd. All Rights Reserved