Contents x
    Upgrading a CTERA Portal
    • 29 Jan 2023
    • 4 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Upgrading a CTERA Portal

    • Updated on 29 Jan 2023
    • 4 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

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

    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.

    Warning

    When upgradiing from CTERA Portal 7.2.x or earlier, you must upgrade both the portal image to the latest portal image as well as the portal software. After upgrading the portal image, you must reboot every server in the CTERA Portal environment.

    Attempting to upgrade the software from version 7.2.x or earlier without first upgrading the portal image, fails with an error message.

    You can upgrade the software from within the portal user interface or via CLI (Upgrading the Portal Software (Via the UI or CLI)) and the image via CLI (Upgrading the Portal Image Via CLI).

    CTERA recommends installing new software and a new image with the help of CTERA Support.

    Notes

    When upgrading a portal to version 7.5.x:

    • The content of the database archive pool is deleted. That is, the base backups and archive files from the main database server and replication server are deleted.

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

    Upgrading the Portal Software (Via the UI or CLI)

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

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

    1. In the global administration view, select Main > Servers in the navigation pane.
      The SERVERS page is displayed, listing all the servers for the CTERA Portal.
      image.png
    2. Click Install new version.
      The Update Software window is displayed.
      image.png
    3. Upload the CTERA Portal version provided by CTERA.
      All servers in the CTERA Portal installation are upgraded.

    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 secondary CTERA Portal servers.
    5. Upgrade the portal software on each secondary CTERA Portal server: portal-manage.sh upgrade upgrade_file
      where upgrade_file is the software file provided by CTERA.
    6. Restart the secondary 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

    Upgrading the Portal Image Via CLI

    When using CLI to upgrade the portal, you have to stop all the portal servers before upgrading the image.

    Note

    Customers without Internet access and upgrading the Portal image from version 6.0.x, 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:

    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 portal image.
      1. Using SSH, log in as root to the CTERA Portal server.
      2. Copy the upgrade installer into the machine.
      3. Navigate to the location of the installer and run the following command: tar xvf portal-installer-linux-7.5.xxx.tar.bz2
      4. Navigate (cd) to the portal-installer-linux-7.3.xxx subdirectory and run the following command: ./install.sh –u
    3. Restart the servers.
      First start the main database server. Next start the replication database server, if available. Finally 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
        When the image kernel was also upgraded, an additional restart is also required to complete the kernel upgrade.
        1. Stop the portal: portal-manage.sh stop
        2. Start the portal: portal-manage.sh start
        Note

        The additional stop and start commands above are mandatory in order to complete the kernel upgrade.

    Was this article helpful?
    What's Next
    Copyright © CTERA Networks Ltd. All Rights Reserved