Upgrade TufinOS 3 to 4 In-Place Central Cluster Appliance

Overview

Upgrade TufinOS 3.x to 4.30 on your existing Tufin Gen 3.5 and Gen 4 appliances.

Use this procedure

  • to upgrade a central cluster with no change in the environment.

Do not use this procedure in any of the following circumstances

Use the same procedure for all nodes in the same cluster.

This procedure does not require reinstalling TOS.

If you have remote clusters, upgrade the central cluster before the remote clusters. For more information on Remote Collector clusters, see Remote Collectors.

Upgrade worker nodes before the primary data node.

During the TufinOS upgrade there will be some downtime. You are going to create a snapshot of the cluster configuration. After the snapshot is created TOS Aurora will be stopped.

Prerequisites

NFS

TufinOS 4.x does not support NFS on this TOS release. NFS is supported from R23-2 PHF2.0.0 and later.

To use NFS for external backups:

  1. Install NFS 4 on your backup server

  2. Upgrade TOS

  3. Upgrade TufinOS

Follow the instructions in the relevant knowledge center.

Alternatively, you can switch to local storage or one of the cloud storage options.

General Requirements

  1. Do not use this procedure if you are upgrading a remote cluster. See overview above.

  2. This procedure must be performed by an experienced Linux administrator with knowledge of network configuration.

  3. For data nodes only. Make sure you do not have unsupported LVM Volume Groups:

    [<ADMIN> ~]$ sudo vgdisplay --noheadings -C -o vg_name | grep -qs -v "[\t ]*VolGroup0[12]$" && echo "You cannot uppgrade."
    sudo vgdisplay --noheadings -C -o vg_name | grep -qs -v "[\t ]*VolGroup0[12]$" && echo "You cannot uppgrade."

    If the output returns "You cannot upgrade.", do not use the upgrade method in the boot menu to upgrade to TufinOS 4.30. Perform a Clean Install.

    If you receive no output, proceed with the next step below.

  4. For data nodes only. Make sure your /var/log partition is large enough:

    [<ADMIN> ~]$ sudo lsblk | grep "MOUNTPOINT\|/var/log$"
    sudo lsblk | grep "MOUNTPOINT\|/var/log$"

    If the output returns a partition size of 400 MB or less, do not perform this upgrade procedure. Perform a Clean Install.

Tufin Appliance Requirements

  • Check which appliance you have:

    [<ADMIN> ~]$ sudo su -
    [<ADMIN> ~]# dmidecode -t chassis | grep "Version:"
    Version: T800

  • Supported Tufin Appliances: T-800, T-1200, T-1100XL, T-1100

  • Older T-1100 and T-1100XL appliances with old RAID controller firmware are not supported.

TufinOS Requirements

  • USB installations:

    For the TufinOS installation, only two USB devices should be connected to the appliance:

    • USB keyboard

    • TufinOS USB installation thumb drive.

  • Serial console installations:

    If you are installing TufinOS on a gen 4 or gen 3.5 appliance via a serial cable connected to a PC, use the following settings:

    • Baud Rate: 57600

    • Data bits: 8

    • Stop bits: 1

    • Parity: None

    • Flow Control: None

    • Terminal type: VT100

Downloads

  1. Download the TufinOS 4.30 installation package from the Download Center.

    • For a Tufin appliance, download the usb image file.

  2. USB installations. Create a USB key for installing TufinOS on appliances.

  3. RMM installations. Extract the TufinOS image from its archive.

    [<ADMIN> ~]$ sudo tar xzvf <FILENAME>.tgz
    sudo tar xzvf <FILENAME>.tgz

    The run file name includes the release, version, build number, and type of installation.

    TufinOS USB file example: TufinOS-4.30-4368238-x86_64-Final.usb.img

  4. RMM installations. Verify the integrity of the TufinOS installation package.

    [<ADMIN> ~]# sha256sum -c TufinOS-X.XX-XXXXXX-x86_64-Final.usb.img.sha256
    sha256sum -c TufinOS-X.XX-XXXXXX-x86_64-Final.usb.img.sha256

    The output should return OK

Preliminary Preparations

    1. Check your current TufinOS version:

      cat /etc/tufinos-release

      Your TufinOS release appears in the output. If the command is not recognized, you have a non-TufinOS operating system and cannot upgrade using this procedure.

    2. If there is a supported upgrade path for your TufinOS release, continue with the upgrade. Otherwise, upgrade first to a supported release.

    1. On the primary data node, check the following status.

      [<ADMIN> ~]$ sudo systemctl status k3s
      sudo systemctl status k3s

      2. In the output under the line k3s.service - Aurora Kubernetes, two lines should appear - Loaded... and Active... similar to the example below. If they appear, continue with the next step, otherwise contact Tufin Support for assistance.

      Example output:

      [<ADMIN> ~]$ sudo systemctl status k3s
 [root@TufinOS ~]# systemctl status k3s
 Redirecting to /bin/systemctl status k3s.service
 ● k3s.service - Aurora Kubernetes
    Loaded: loaded (/etc/systemd/system/k3s.service; enabled; vendor preset: disabled)
    Active: active (running) since Tue 2021-08-24 17:14:38 IDT; 1 day 18h ago
      Docs: https://k3s.io
   Process: 1241 ExecStartPre=/sbin/modprobe overlay (code=exited, status=0/SUCCESS)
   Process: 1226 ExecStartPre=/sbin/modprobe br_netfilter (code=exited, status=0/SUCCESS)
  Main PID: 1250 (k3s-server)
     Tasks: 1042
    Memory: 2.3G

    2. On the same node or nodes, check the TOS status.

      [<ADMIN> ~]$ sudo tos status
      sudo tos status

      3. In the output, if the System Status is Ok and all the items listed under Components appear as ok, continue with the next steps. Otherwise contact Tufin Support for assistance.

      Example output:

      [<ADMIN> ~]$ sudo tos status
 Tufin Orchestration Suite 2.0
  
 System Status: Ok
 System Mode:   Multi Node
  
 Nodes:
   1 Master, 1 Worker. Total 2 nodes. Nodes are healthy.
  
 Components:
   Node:            Ok
   Cassandra:       Ok
   Mongodb:         Ok
   Mongodb_sc:      Ok
   Nats:            Ok
   Neo4j:           Ok
   Postgres:        Ok
   Postgres_sc:     Ok

  3. If you are going to perform this procedure over multiple maintenance periods, create a new backup each time.

    1. Create the backup using tos backup create: 

      2. [<ADMIN> ~]$ sudo tos backup create
      sudo tos backup create

      Example output:

      [%=Local.admin-prompt% sudo tos backup create
[Aug 23 16:18:42]  INFO Running backup
Backup status can be monitored with "tos backup status"

    2. You can check the backup creation status using tos backup status, which shows the status of backups in progress. Wait until completion before continuing.

      3. [<ADMIN> ~]$ sudo tos backup status
      sudo tos backup status

      Example output:

      [<ADMIN> ~]$ sudo tos backup status
 Found active backup "23-august-2021-16-18"

    3. Run the following command to display the list of backups saved on the node:

      [<ADMIN> ~]$ sudo tos backup list
      sudo tos backup list

      4. Example output:

      [<ADMIN> ~]$ sudo tos backup list
 ["23-august-2021-16-18"]
   Started: "2021-08-23 13:18:43 +0000 UTC"
   Completed: "N/A"
   Modules: "ST, SC"
   HA mode: "false"
   TOS release: "21.2 (PGA.0.0) Final"
   TOS build: "21.2.2100-210722164631509"
   Expiration Date: "2021-09-22 13:18:43 +0000 UTC"
   Status: "Completed"

    4. Check that your backup file appears in the list, and that the status is "Completed".

    5. Run the following command to export the backup to a file: 

      [<ADMIN> ~]$ sudo tos backup export
      sudo tos backup export

      6. The command creates a single backup file.

      [<ADMIN> ~]$ sudo tos backup export
 [Aug 23 16:33:42]  INFO Preparing target dir /opt/tufin/backups
 [Aug 23 16:33:42]  INFO Compressing...
 [Aug 23 16:33:48]  INFO Backup exported file: /opt/tufin/backups/backup-21-2-pga.0.0-final-20210823163342.tar.gzip 
 [Aug 23 16:33:48]  INFO Backup export has completed

    6. If your backup files are saved locally:

      1. Run sudo tos backup export to save your backup file from a TOS backup directory as a single .gzip file. If there are other backups present, they will be included as well.

      2. Transfer the exported .gzip file to a safe, remote location.

        Make sure you have the location of your backups safely documented and accessible, including credentials needed to access them, for recovery when needed.

      After the backup is exported, we recommend verifying that the file contents can be viewed by running the following command:

      [Target location]$ tar tzvf <filename>
      tar tzvf <file name>

  4. If you are currently upgrading the central cluster, make sure all the Remote Collector clusters are connected. On the Central cluster primary data node run:

    [<ADMIN> ~]$ sudo tos cluster list
    sudo tos cluster list

    The output shows all connected clusters.

    Example output:

    $ sudo tos cluster list
    NAME    ID    IP                TYPE

    Central    1                    master
    RC1        2    192.168.75.156    data_collector

  5. If you are running a multi-node cluster, get a list of your nodes and note them down for later.

    [<ADMIN> ~]$ sudo tos cluster node list
    sudo tos cluster node list

  6. The upgrade to TufinOS 4 keeps the TOS Aurora data in the /opt partition. The upgrade to TufinOS 4 is like a regular TufinOS installation with one enhancement that keeps the untouched /opt partition, thus all the TOS Aurora data remains available after this upgrade.

    This is not the case with TufinOS configuration data. The upgrade erases all existing TufinOS configurations. Therefore, before you start create a list of the data you want to keep and save it outside the machine you are upgrading.

    After the upgrade completion, re-configure all your backed-up data before restoring the TOS Aurora snapshot.

    For more information on what to information to save, see Saving Your TufinOS Configuration:

    If you have any questions about the upgrade, contact the Tufin support team. Do not attempt the upgrade if you are unsure about any part of it.

Upgrade Worker Nodes

Repeat these steps for each worker node.

    1. Identify the node you want to remove and its status by running sudo tos cluster node list on the primary data node.

    2. Run sudo tos cluster node list.

      • If the node is in a healthy state:

        1. On the primary data node, run:

          [<ADMIN> ~]$ sudo tos cluster node remove <node>
          sudo tos cluster node remove <node>

          Parameters

          Parameter

          Description

          Required/Optional

          <node>

          Hostname address of the node to remove.

          Required

          On completion, a new command string is displayed, which you will need to run on the node you want to remove within 30 minutes. If the allocated time expires, you will need to repeat the current step.

        2. Log in to the CLI of the node to be removed.

        3. On the node to be removed, run the command string displayed on completion of the command above. On completion, all TOS-related directories and data will be deleted from the node, therefore make sure you run it on the correct node. Running the command on the wrong node will destroy the cluster.

        All TOS-related directories will be deleted from the node.

      • If the node you want to remove is not in a healthy state:

        1. On the primary data node, run:

          [<ADMIN> ~]$ sudo tos cluster node remove <node> --force
          sudo tos cluster node remove <node> --force

          Parameters

          Parameter

          Description

          Required/Optional

          <node>

          Hostname address of the node to remove.

          Required
    3. Verify that the node has been removed by again running sudo tos cluster node list.

  2. Install TufinOS

      1. Before beginning check that there are no physical USB thumb drives connected to the appliance and that there is no virtual media attached to the appliance via a remote management module.

      1. Insert the USB drive into the appliance and reboot the appliance.

        2. The TufinOS 4.30 installer launches.

      2. Select TufinOS 4.30 installation for TOS Aurora.

      3. Select one of the following options:

        • Install 4.30 via KVM

        • Install 4.30 via serial - The serial option is only relevant if you are connecting a serial cable to the appliance, and you have a serial console configured to connect to the appliance (see TufinOS Requirements).

      4. When prompted, select Yes.

      5. When the installation is complete, reboot the appliance.

      6. When the BIOS POST starts, remove the USB thumb drive with the TufinOS installation image.

      7. Once the device has rebooted, log in again as tufin-admin. The default admin user credentials are:

        • username: tufin-admin

        • password: admin

      8. The system requires that you change the password on the first login.

      2. Before beginning check that there are no physical USB thumb drives connected to the appliance.

      1. On your computer, open Configure Java > Security.

      2. Click Edit Site List and add a URL with the RMM IP address. For example:

        HTTPS://<rmm_ip>

      3. Open a browser, enter the RMM IP address and enter username and password to log in.

      4. On the Remote Control tab, click Launch Console, accept any warning messages until the KVM window appears.

      5. In the KVM window, go to Device > Redirect Floppy/USB Key Image, select the image file, and click Open.

        6. The TufinOS 4.30 installer launches.

      6. Select TufinOS 4.30 installation for TOS Aurora.

      7. Select one of the following options:

      8. Install 4.30 via KVM

      9. When prompted, select Yes.

      10. When the installation is complete, reboot the appliance.

      11. When the BIOS POST starts, detach the TufinOS installation image. Go to Device, and clear Redirect Floppy/USB Key Image

      12. Once the device has rebooted, log in again as tufin-admin. The default admin user credentials are:

        • username:tufin-admin

        • password: admin

      13. The system requires that you change the password on the first login.

      3. Before beginning check that there are no physical USB thumb drives connected to the appliance.

      1. Open a browser, enter the RMM IP address and enter username and password to log in.

      2. On the System tab, in the Remote Console Preview area, click on the black area and accept any warning messages until the KVM window appears.

      3. In the KVM window go to Virtual Media > Virtual Storage. click on HD Image in Logical Drive Type and click Open Image.

      4. Select the image file, and click Open.

      5. Click Plug in > OK and confirm that the connection status is OK.

      6. Reboot the appliance.

        7. The TufinOS 4.30 installer launches.

      7. Select TufinOS 4.30 installation for TOS Aurora.

      8. Select Install 4.30 via KVM

      9. When prompted, select Yes.

      10. When the installation is complete, reboot the appliance.

        11. When the BIOS POST starts, detach the TufinOS installation image. Go to Virtual Media > Virtual Storage, click Plug out, and then OK.

      11. Once the device has rebooted, log in again as tufin-admin. The default admin user credentials are:

        • username:tufin-admin

        • password: admin

      12. The system requires that you change the password on the first login.

    1. Restore the TufinOS configuration data that you saved before beginning the upgrade procedure (see Save Your TufinOS Configuration). In general we recommend that the new server configurations be similar to the old configurations.

    2. Configure the server timezone:

      [<ADMIN> ~]$ sudo timedatectl set-timezone <timezone>
      sudo timedatectl set-timezone <timezone>

      where <timezone> is in the format Area/Location. Examples: America/Jamaica, Hongkong, GMT, Europe/Prague.

      To view a list of the time-zone formats that can be used, run:

      [<ADMIN> ~]$ sudo timedatectl list-timezones
      sudo timedatectl list-timezones

    3. Synchronize your machine time with a trusted NTP server. Follow the steps in Configuring NTP Using Chrony. In an HA deployment, all servers need to be synchronized to the same time.

    4. To assign a static IP address or restore one that was used before upgrading:

      1. Run the command: 

        2. [<ADMIN> ~]$ sudo nmtui edit <Interface Name>
        sudo nmtui edit <Interface Name>

        and set the following parameters in the window:

        • Set IPv4 CONFIGURATION to Manual
        • Set Addresses for the physical IP, together with the chosen subnet
        • Set Gateway and DNS Servers to the IPs used by your organization
      2. Restart the network service. 
        3. [<ADMIN> ~]$ sudo systemctl restart NetworkManager.service
        sudo systemctl restart NetworkManager.service

    5. Run:

      [<ADMIN> ~]$ sudo nslookup <DNS SERVER IP>
      sudo nslookup <DNS SERVER IP>

      If the name of the server is displayed, the DNS server can resolve its own address using a reverse lookup.

      Example Output

      [<ADMIN> ~]$ sudo nslookup  1.2.3.4
4.3.2.1.in-addr.arpa	name=EXAMPLE.company.com

      If the name of the server is not displayed, set it using a reverse lookup entry at /etc/hosts.

      Example Output where 1.2.3.4 4.3.2.1.in-addr-arpa was added.

      [<ADMIN> ~]$ sudo cat /etc/hosts 
127.0.0.1 localhost localhost.localdomain localhost4 localhost4.localdomain4
::1 localhost6 localhost6.localdomain6
1.2.3.4 admin.company.com admin
2.3.4.5 5.4.3.2.in-addr-arpa

       

    1. On the primary data node run:

      [<ADMIN> ~]$ sudo tos cluster node add --role=<TYPE>
      sudo tos cluster node add --role=<TYPE>

      where <TYPE> is worker or data, depending on the type of node you want to add.

      On completion, a new command string is displayed, which you will need to run on the new node within one hour. If the allocated time expires, you will need to repeat the current step.

    2. Log in to the CLI of the server to be added as a new node in the cluster.

    3. On the new node, run the command string displayed previously on the primary data node in step 2 above. If the allocated time has expired, you will need to start from the beginning.
    4. Verify that the node was added by running sudo tos cluster node list on the primary data node.

    1. On the primary data nodes, check the TOS status.

      [<ADMIN> ~]$ sudo tos status
      sudo tos status

    2. In the output, check if the System Status is Ok and all the items listed under Components appear as ok. If this is not the case, contact Tufin Support.

      3. Example output:

      [<ADMIN> ~]$ sudo tos status
 Tufin Orchestration Suite 2.0

 System Status: Ok
 System Mode:   Multi Node

 Nodes:
   1 Master, 1 Worker. Total 2 nodes. Nodes are healthy.

 Components:
   Node:            Ok
   Cassandra:       Ok
   Mongodb:         Ok
   Mongodb_sc:      Ok
   Nats:            Ok
   Neo4j:           Ok
   Postgres:        Ok
   Postgres_sc:     Ok

Upgrade the Data Node

  1. cluster configuration.
    1. On the data node, run the following command: 
      [<ADMIN> ~]$ sudo tos cluster snapshot create
      sudo tos cluster snapshot create

      A message appears "The system will shut down until the process is finished. Please confirm Y/N."

    2. Type Yes.

      TOS Aurora is stopped.

  2. Upgrade TufinOS

      1. Before beginning check that there are no physical USB thumb drives connected to the appliance and that there is no virtual media attached to the appliance via a remote management module.

      1. Insert the USB drive into the appliance and reboot the appliance.

        2. The TufinOS 4.30 installer launches.

      2. Select TufinOS 3 Upgrade for TOS Aurora.

      3. Select one of the following options:

        • Upgrade from TufinOS 3 to TufinOS 4.30 via KVM

        • Upgrade from TufinOS 3 to TufinOS 4.30 via serial - The serial option is only relevant if you are connecting a serial cable to the appliance, and you have a serial console configured to connect to the appliance.

      4. When prompted, select Yes.

      5. When the installation is complete, reboot the appliance.

      6. When the BIOS POST starts, remove the USB thumb drive with the TufinOS installation image.

      7. Once the device has rebooted, log in again as tufin-admin. The default admin user credentials are:

        • username:tufin-admin

        • password: admin

      8. The system requires that you change the password on the first login.

      2. Before beginning check that there are no physical USB thumb drives connected to the appliance.

      1. On your computer, open Configure Java > Security.

      2. Click Edit Site List and add a URL with the RMM IP address. For example:

        HTTPS://<rmm_ip>

      3. Open a browser, enter the RMM IP address and enter username and password to log in.

      4. On the Remote Control tab, click Launch Console, accept any warning messages until the KVM window appears.

      5. In the KVM window, go to Device > Redirect Floppy/USB Key Image, select the image file, and click Open.

      6. The TufinOS 4.30 installer launches.

      7. Select TufinOS 3 Upgrade for TOS Aurora.

      8. Select Upgrade from TufinOS 3 to TufinOS 4.30 via KVM

      9. When prompted, select Yes.

      10. When the installation is complete, reboot the appliance.

      11. When the BIOS POST starts, detach the TufinOS installation image. Go to Device, and clear Redirect Floppy/USB Key Image

      12. Once the device has rebooted, log in again as tufin-admin. The default admin user credentials are:

        • username:tufin-admin

        • password: admin

      13. The system requires that you change the password on the first login.

      3. Before beginning check that there are no physical USB thumb drives connected to the appliance.

      1. Open a browser, enter the RMM IP address and enter username and password to log in.

      2. On the System tab, in the Remote Console Preview area, click on the black area and accept any warning messages until the KVM window appears.

      3. In the KVM window go to Virtual Media > Virtual Storage. click on HD Image in Logical Drive Type and click Open Image.

      4. Select the image file, and click Open.

      5. Click Plug in > OK and confirm that the connection status is OK.

      6. Reboot the appliance.

      7. The TufinOS 4.30 installer launches.

      8. Select TufinOS 3 Upgrade for TOS Aurora.

      9. Select Upgrade from TufinOS 3 to TufinOS 4.30 via KVM.

      10. When prompted, select Yes.

      11. When the installation is complete, reboot the appliance.

        12. When the BIOS POST starts, detach the TufinOS installation image. Go to Virtual Media > Virtual Storage, click Plug out, and then OK.

      12. Once the device has rebooted, log in again as tufin-admin. The default admin user credentials are:

        • username:tufin-admin

        • password: admin

      13. The system requires that you change the password on the first login.

    1. Restore the TufinOS configuration data that you saved before beginning the upgrade procedure (see Save Your TufinOS Configuration). In general we recommend that the new server configurations be similar to the old configurations.

    2. Configure the server timezone:

      [<ADMIN> ~]$ sudo timedatectl set-timezone <timezone>
      sudo timedatectl set-timezone <timezone>

      where <timezone> is in the format Area/Location. Examples: America/Jamaica, Hongkong, GMT, Europe/Prague.

      To view a list of the time-zone formats that can be used, run:

      [<ADMIN> ~]$ sudo timedatectl list-timezones
      sudo timedatectl list-timezones

    3. Synchronize your machine time with a trusted NTP server. Follow the steps in Configuring NTP Using Chrony. In an HA deployment, all servers need to be synchronized to the same time.

    4. To assign a static IP address or restore one that was used before upgrading:

      1. Run the command: 

        2. [<ADMIN> ~]$ sudo nmtui edit <Interface Name>
        sudo nmtui edit <Interface Name>

        and set the following parameters in the window:

        • Set IPv4 CONFIGURATION to Manual
        • Set Addresses for the physical IP, together with the chosen subnet
        • Set Gateway and DNS Servers to the IPs used by your organization
      2. Restart the network service. 
        3. [<ADMIN> ~]$ sudo systemctl restart NetworkManager.service
        sudo systemctl restart NetworkManager.service

    5. Run:

      [<ADMIN> ~]$ sudo nslookup <DNS SERVER IP>
      sudo nslookup <DNS SERVER IP>

      If the name of the server is displayed, the DNS server can resolve its own address using a reverse lookup.

      Example Output

      [<ADMIN> ~]$ sudo nslookup  1.2.3.4
4.3.2.1.in-addr.arpa	name=EXAMPLE.company.com

      If the name of the server is not displayed, set it using a reverse lookup entry at /etc/hosts.

      Example Output where 1.2.3.4 4.3.2.1.in-addr-arpa was added.

      [<ADMIN> ~]$ sudo cat /etc/hosts 
127.0.0.1 localhost localhost.localdomain localhost4 localhost4.localdomain4
::1 localhost6 localhost6.localdomain6
1.2.3.4 admin.company.com admin
2.3.4.5 5.4.3.2.in-addr-arpa

       

  4. Run the following command:

    [<ADMIN> ~]$ sudo /opt/tufin/cluster-snapshot/binaries/tos cluster snapshot restore
    sudo /opt/tufin/cluster-snapshot/binaries/tos cluster snapshot restore

    1. On the primary data nodes, check the TOS status.

      [<ADMIN> ~]$ sudo tos status
      sudo tos status

    2. In the output, check if the System Status is Ok and all the items listed under Components appear as ok. If this is not the case, contact Tufin Support.

      3. Example output:

      [<ADMIN> ~]$ sudo tos status
 Tufin Orchestration Suite 2.0

 System Status: Ok
 System Mode:   Multi Node

 Nodes:
   1 Master, 1 Worker. Total 2 nodes. Nodes are healthy.

 Components:
   Node:            Ok
   Cassandra:       Ok
   Mongodb:         Ok
   Mongodb_sc:      Ok
   Nats:            Ok
   Neo4j:           Ok
   Postgres:        Ok
   Postgres_sc:     Ok