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 image, which automatically upgrades the portal software, or just the portal 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 or just a portal software upgrade. When a performing a portal upgrade that includes upgrading the portal image the image upgrade includes upgrading the software.

You can upgrade both the image and the software (Upgrading the Portal Image and Software) or just the software (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.

CTERA Portal requires two networks, one for external client-facing traffic and one for internal communcation. You require these two networks on each portal server.

Warning

If the current network configuration uses eth0 for the portal network and eth1 is free, then the upgrade can proceed. If, however, eth0 or eth1 are not available, you must contact CTERA Support, as changes need to be made to portal.cfg before you can continue.

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, add a second network to each server.
  3. 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 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: chmod +x rpm_upgrade.sh && ./rpm_upgrade.sh

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 a Portal with the CTERA Messaging Service Implemented

After the upgrade, run the following command on every messaging server: curl http://localhost:8083/connector-plugins

The expected output:

[{"class":"io.confluent.connect.jdbc.JdbcSinkConnector","type":"sink","version":"10.5.1"},
{"class":"io.confluent.connect.jdbc.JdbcSourceConnector","type":"source","version":"10.5.1"},
{"class":"io.debezium.connector.postgresql.PostgresConnector","type":"source","version":"1.9.5.Final"},
{"class":"org.apache.kafka.connect.mirror.MirrorCheckpointConnector","type":"source","version":"7.2.1-ccs"},
{"class":"org.apache.kafka.connect.mirror.MirrorHeartbeatConnector","type":"source","version":"7.2.1-ccs"},
{"class":"org.apache.kafka.connect.mirror.MirrorSourceConnector","type":"source","version":"7.2.1-ccs"}]

If there is a different output, run docker restart kafka_connect_kafka_connect_1

Upgrading a Portal with Subfolder Quotas Configured

A migration using the CTERA SDK is required to configure the subfolder quotas in the portal. For details, contact CTERA Support.

Upgrading the Portal Software

You can upgrade the portal software via the command line.

Note

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

CTERA Portal requires two networks, one for external client-facing traffic and one for internal communcation. You require these two networks on each portal server.

Warning

If the current network configuration uses eth0 for the portal network and eth1 is free, then the upgrade can proceed. If, however, eth0 or eth1 are not available, you must contact CTERA Support, as changes need to be made to portal.cfg before you can continue.

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, add a second network to each server.
  3. 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.
  4. Restart the primary database server: portal-manage.sh start
  5. 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