Upgrade TufinOS 3 to 4: In-place, VMWare ESXi, Central/Remote Cluster, TOS Reinstall

Overview

This procedure is for upgrading TufinOS 3 to 4 on the same VMWare ESXi machines in a central or remote cluster. For central clusters, this is relevant when there are changes to the server configuration. This requires upgrading first the worker nodes and then the data node.

If you have both central and remote clusters, upgrade the central cluster first.

During the TufinOS upgrade there will be some downtime. TOS will need to be reinstalled

Is This The Right Procedure?

This procedure is ONLY for:

  • TOS R24-2

  • Single data node remote clusters

  • Single data node central clusters - if you plan on making changes to the server configurations (for example: IP address, server timezone)

  • Upgrades on the same VMWare ESXI machines

If your TOS release is not R24-2, go to the Knowledge Center that matches your TOS version. If other requirements are not met, select a different procedure.

Prerequisites

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

  2. Ensure that each partition has at least 30% available space. No partition should exceed 70% usage. 
    [<ADMIN> ~]$ df -h | awk '$5+0 > 70 {print $0}'
    df -h | awk '$5+0 > 70 {print $0}'

    Do not proceed with the upgrade until the output returns 0 results.

  3. For R24-2 PGA.0.0 and later, if you are using NFS your backup server needs to be running NFS 4.

    From R24-2 PHF1.0.0 and later, if you are running NFS 3 on your backup server it will not work because of a security vulnerability. If you want to ignore the security vulnerability to enable NFS 3, you need to run the following commands on all TOS servers that are using TufinOS 4.20 and later:

    systemctl unmask rpcbind.socket rpcbind.service
    systemctl unmask rpcbind.socket rpcbind.service
    systemctl start rpcbind.socket rpcbind.service
    systemctl start rpcbind.socket rpcbind.service
    systemctl enable rpcbind.socket rpcbind.service
    systemctl enable rpcbind.socket rpcbind.service

  4. For data nodes only. If you have not already separated the etcd database, add a second disk to the machine.

    • Size: 50 GB

    • Select a storage type of SSD. Take into consideration that TOS requires 7,500 IOPS and the throughput expected will average 250MB/s with bursts of up to 700MB/s.

Downloads

  1. Download the TufinOS 4.50 installation package from the Download Center to your local machine.

    • For a VMWare ESXi machine, download the .iso image file.

  2. 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 ISO file example: TufinOS-4.50-4368238-x86_64-Final.iso

  3. Verify the integrity of the TufinOS installation package.

    [<ADMIN> ~]# sha256sum -c TufinOS-X.XX-XXXXXX-x86_64-Final.iso.sha256
    sha256sum -c TufinOS-X.XX-XXXXXX-x86_64-Final.iso.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. Review the compatibility and requirements and supported upgrade paths for TufinOS 4.50 and verify that you can perform the procedure.

    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

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

        [<ADMIN> ~]$ tos status
        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 for a central cluster data node:

        [<ADMIN> ~]$ tos status         
[Mar 28 13:42:09]  INFO Checking cluster health status           
TOS Aurora
Tos Version: 24.2 (PRC1.1.0)

System Status: "Ok"
            
Cluster Status:
   Status: "Ok"
   Mode: "Multi Node"

Nodes
  Nodes:
  - ["node1"]
    Type: "Primary"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 19%
  - ["node3"]
    Type: "Worker Node"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 4%

registry
  Expiration ETA: 819 days
  Status: "Ok"

Infra
Databases:
- ["cassandra"]
  Status: "Ok"
- ["kafka"]
  Status: "Ok"
- ["mongodb"]
  Status: "Ok"
- ["mongodb_sc"]
  Status: "Ok"
- ["ongDb"]
  Status: "Ok"
- ["postgres"]
  Status: "Ok"
- ["postgres_sc"]
  Status: "Ok"

Application
Application Services Status OK
Running services 50/50

Remote Clusters
Number Of Remote Clusters: 2
  - ["RC"]
     Connectivity Status:: "OK:"
  - ["RC2"]
     Connectivity Status:: "OK"

  Backup Storage:
  Location: "Local
s3:http://minio.default.svc:9000/velerok8s/restic/default "
  Status: "Ok"
  Latest Backup: 2024-03-23 05:00:34 +0000 UTC

        Example output for a remote cluster data node:

        [<ADMIN> ~]$ tos status         
[Mar 28 13:42:09]  INFO Checking cluster health status           
TOS Aurora
Tos Version: 24.2 (PRC1.0.0)

System Status: "Ok"
            
Cluster Status:
   Status: "Ok"
   Mode: "Single Node"

Nodes
  Nodes:
  - ["node2"]
    Type: "Primary"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 19%
  
registry
  Expiration ETA: 819 days
  Status: "Ok"

Infra
Databases:
- ["mongodb"]
  Status: "Ok"
- ["postgres"]
  Status: "Ok"

Application
Application Services Status OK
Running services 16/16

  Backup Storage:
  Location: "Local
s3:http://minio.default.svc:9000/velerok8s/restic/default "
  Status: "Ok"
  Latest Backup: 2024-03-23 05:00:34 +0000 UTC
  3. This needs to be performed for all primary data nodes - the central cluster and remote collector clusters.

    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. 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. 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.

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

  6. The TOS backup does not include your 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 TOS Aurora.

    For more information on what to information to save, see Save 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 worker node you want to remove.

    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 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.

    1. Place the TufinOS ISO image file on the datastore of vSphere. For local installation on a VMware machine, locate the extracted ISO image file.

    2. Confirm that in your virtual machine settings, Boot Options is configured to use BIOS. If you are using EFI, the procedure will not work.

    3. Edit the properties of the virtual CD/DVD drive, and do one of the following:

      Using vSphere:

      • As Device Type select Datastore ISO file, and browse to the TufinOS ISO image.

      • Under Device Status, select Connect at power on.

      Using a workstation:

      • Under Device Status, select Connect at power on.

      • Under Connection, select Use ISO image file, and browse to the TufinOS ISO image.

    4. Set the VM to boot to BIOS configuration

      1. Navigate to VM settings > VM options.
      2. Check: During the next boot, force entry into the BIOS setup screen.

    5. In BIOS > Boot, select CD-ROM Drive.

    6. In BIOS > Exit, select Exit Saving Changes. Click Yes.

    7. Save the settings.

    8. Restart the VM. TufinOS installation begins.

      1. Shut down TOS.

        [<ADMIN> ~]# tos stop
        tos stop

      2. Restart the virtual machine. TufinOS installation begins.

    10. Select TufinOS 4.50 Installation for TOS Aurora.

    11. Select Install TufinOS 4.50 for Worker Node.

    12. When prompted, confirm and choose Yes.

    13. When the installation is complete, reboot the virtual machine.

    14. When BIOS launches, change the Boot option to Hard Drive.

    15. In BIOS > Exit, select Exit Saving Changes. Click Yes.

    16. Log in using the default admin user credentials:

      username: tufin-admin

      password: admin (you will be prompted to change this on first log in)

      IP address: assigned by DHCP

    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. If you want to reset the host name or IP of the machine, do so now. It cannot be done at a later stage. See Changing IP Address/Host Names.

    3. If you want to configure NIC bonding, do so now. It cannot be done at a later stage. See Link Redundancy on Tufin Appliances.

    4. 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
      Ukraine only. Since the change in timezone name from Kiev to Kyiv, not all software products have been adjusted. We therefore recommend avoiding these names and instead using an alternative city in the same timezone such as Europe/Tallinn.

    5. 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.

    6. Configure the IP address and DNS, where <Interface Name> is the name of the interface you are using (for example, ens32). If you have several network interfaces, configure the first one.

      Run the command: 

      [<ADMIN> ~]$ sudo /opt/tufinos/scripts/network_interface_by_pci_order.sh | awk -F'=' '/NET_IFS\[0\]/ { print $NF }'
      sudo /opt/tufinos/scripts/network_interface_by_pci_order.sh | awk -F'=' '/NET_IFS\[0\]/ { print $NF }'

    7. 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

    8. 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 node, check the TOS status.

      [<ADMIN> ~]$ tos status
      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 for a central cluster data node:

      [<ADMIN> ~]$ tos status         
[Mar 28 13:42:09]  INFO Checking cluster health status           
TOS Aurora
Tos Version: 24.2 (PRC1.1.0)

System Status: "Ok"
            
Cluster Status:
   Status: "Ok"
   Mode: "Multi Node"

Nodes
  Nodes:
  - ["node1"]
    Type: "Primary"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 19%
  - ["node3"]
    Type: "Worker Node"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 4%

registry
  Expiration ETA: 819 days
  Status: "Ok"

Infra
Databases:
- ["cassandra"]
  Status: "Ok"
- ["kafka"]
  Status: "Ok"
- ["mongodb"]
  Status: "Ok"
- ["mongodb_sc"]
  Status: "Ok"
- ["ongDb"]
  Status: "Ok"
- ["postgres"]
  Status: "Ok"
- ["postgres_sc"]
  Status: "Ok"

Application
Application Services Status OK
Running services 50/50

Remote Clusters
Number Of Remote Clusters: 2
  - ["RC"]
     Connectivity Status:: "OK:"
  - ["RC2"]
     Connectivity Status:: "OK"

  Backup Storage:
  Location: "Local
s3:http://minio.default.svc:9000/velerok8s/restic/default "
  Status: "Ok"
  Latest Backup: 2024-03-23 05:00:34 +0000 UTC

      Example output for a remote cluster data node:

      [<ADMIN> ~]$ tos status         
[Mar 28 13:42:09]  INFO Checking cluster health status           
TOS Aurora
Tos Version: 24.2 (PRC1.0.0)

System Status: "Ok"
            
Cluster Status:
   Status: "Ok"
   Mode: "Single Node"

Nodes
  Nodes:
  - ["node2"]
    Type: "Primary"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 19%
  
registry
  Expiration ETA: 819 days
  Status: "Ok"

Infra
Databases:
- ["mongodb"]
  Status: "Ok"
- ["postgres"]
  Status: "Ok"

Application
Application Services Status OK
Running services 16/16

  Backup Storage:
  Location: "Local
s3:http://minio.default.svc:9000/velerok8s/restic/default "
  Status: "Ok"
  Latest Backup: 2024-03-23 05:00:34 +0000 UTC

Upgrade the Data Node

  1. This needs to be performed for all primary data nodes - the central cluster and remote collector clusters.

    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. 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>

    1. Place the TufinOS ISO image file on the datastore of vSphere. For local installation on a VMware machine, locate the extracted ISO image file.

    2. Confirm that in your virtual machine settings, Boot Options is configured to use BIOS. If you are using EFI, the procedure will not work.

    3. Edit the properties of the virtual CD/DVD drive, and do one of the following:

      Using vSphere:

      • As Device Type select Datastore ISO file, and browse to the TufinOS ISO image.

      • Under Device Status, select Connect at power on.

      Using a workstation:

      • Under Device Status, select Connect at power on.

      • Under Connection, select Use ISO image file, and browse to the TufinOS ISO image.

    4. Set the VM to boot to BIOS configuration

      1. Navigate to VM settings > VM options.
      2. Check: During the next boot, force entry into the BIOS setup screen.

    5. In BIOS > Boot, select CD-ROM Drive.

    6. In BIOS > Exit, select Exit Saving Changes. Click Yes.

    7. Save the settings.

    8. Restart the VM. TufinOS installation begins.

    9. Select TufinOS 4.50 installation for TOS Aurora.

    10. Select Install TufinOS 4.50 for Data Node.

    11. When prompted, confirm and choose Yes.

    12. When the installation is complete, reboot the virtual machine.

    13. When BIOS launches, change the Boot option to Hard Drive.

    14. In BIOS > Exit, select Exit Saving Changes. Click Yes.

    15. Log in using the default admin user credentials:

      username: tufin-admin

      password: admin (you will be prompted to change this on first log in)

      IP address: assigned by DHCP

    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. If you want to reset the host name or IP of the machine, do so now. It cannot be done at a later stage. See Changing IP Address/Host Names.

    3. If you want to configure NIC bonding, do so now. It cannot be done at a later stage. See Link Redundancy on Tufin Appliances.

    4. 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
      Ukraine only. Since the change in timezone name from Kiev to Kyiv, not all software products have been adjusted. We therefore recommend avoiding these names and instead using an alternative city in the same timezone such as Europe/Tallinn.

    5. 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.

    6. Configure the IP address and DNS, where <Interface Name> is the name of the interface you are using (for example, ens32). If you have several network interfaces, configure the first one.

      Run the command: 

      [<ADMIN> ~]$ sudo /opt/tufinos/scripts/network_interface_by_pci_order.sh | awk -F'=' '/NET_IFS\[0\]/ { print $NF }'
      sudo /opt/tufinos/scripts/network_interface_by_pci_order.sh | awk -F'=' '/NET_IFS\[0\]/ { print $NF }'

    7. 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

    8. 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. Run the tmux command.

      [<ADMIN> ~]$ tmux new-session -s TOS-Install
      tmux new-session -s TOS-Install

    2. Create the directory /opt/misc/, if it does not exist already.

    3. Go to /opt/misc/.

    4. Go to the Download Center and click the TOS R24-2 PHF4.1.0 installation file.

    5. Select how you want to download the installation package: Download to Computer or Copy link (valid for 10m).

    6. If you copied the link, run the following command within ten minutes:

      curl -o [Name the file].run.gz  “<LINK>”
      curl -o [Name the file].run.gz  “<LINK>”

      Where <LINK> is the link you copied from the Download Center.

      Make sure the server can download from https://tosportaldownloads.tufin.com.

    7. If you downloaded to the computer, copy the compressed file from your local computer to the server.

    8. Verify the integrity of the TOS installation packages by entering the following commands and comparing the output with the checksum information.

      9. [<ADMIN> ~]$ sha256sum tos-xxxx-xxxxxxxx-final-xxxx.run.tgz
      sha256sum tos-xxxx-xxxxxxxx-final-xxxx.run.tgz
      [<ADMIN> ~]$ sha1sum tos-xxxx-xxxxxxxx-final-xxxx.run.tgz
      sha1sum tos-xxxx-xxxxxxxx-final-xxxx.run.tgz

    9. Extract the TOS run file from its archive.

      [<ADMIN> ~]$ tar xvzf tos-xxxx-xxxxxxxx-final-xxxx.run.tgz
      tar xvzf tos-xxxx-xxxxxxxx-final-xxxx.run.tgz

      10. The run file name includes the release, version, and build number.

      TOS file example: R24-2-pga0.0-final-4577.run

    1. Run the TOS Aurora run file.

      [<ADMIN> ~]$ cd /opt/misc/
      cd /opt/misc/
      [<ADMIN> ~]$ sudo sh <runfile>
      sudo sh <runfile>

    2. Run the install command, replacing the parameters:

      • <MODULE-TYPE> - One of the following values:

        • ST for SecureTrack only

        • ST, SC for both SecureTrack and SecureChange/SecureApp

        • RC for a remote collector

      • <PRIMARY> - The VIP you will use to access TOS Aurora as described in Prerequisites

      • <SERVICE-CIDR> - The CIDR you want to use for the Kubernetes service network, as described in Prerequisites

      • <PODS-CIDR>Optional. The CIDR you want to use for the Kubernetes pods network, as described in Prerequisites. The default pods network is 10.244.0.0/16

      • <LOAD> - small, medium or large, as provided by your account team, based on your sizing calculation.

      There is also an option to do a dry run, to verify the procedure in advance by going through all the stages without installing anything. To do a dry run, add the parameter --dry-run to the install command.

      [<ADMIN> ~]$ sudo tos install --modules=<MODULE-TYPE> --primary-vip=<PRIMARY> --services-network=<SERVICE-CIDR> --pod-network=<PODS-CIDR> --load-model=<LOAD> -d
      sudo tos install --modules=<MODULE-TYPE> --primary-vip=<PRIMARY> --services-network=<SERVICE-CIDR> --pod-network=<PODS-CIDR> --load-model=<LOAD> -d

      Examples:

      $ sudo tos install --modules=ST,SC --primary-vip=192.168.1.2 --services-network=10.10.10.0/24 --load-model=medium -d

      $ sudo tos install --modules=RC --primary-vip=162.148.10.0 --services-network=10.10.10.0/24 --load-model=large -d

    3. The EULA is displayed. After reading, enter q to exit the document. If you accept the EULA, enter y and wait until the command completes.

    1. You can now safely exit the CLI tmux session:

      [<ADMIN> ~]# exit
      exit

    2. If the installation was for a central (main) cluster, log into TOS Aurora at https://<VIP> in your browser with user=admin, password=admin. If a warning message is shown regarding the site security certificate, 'accept the risk' and continue to the site. You will be prompted to set a new password.

      If the installation was for a remote collector, connect it to the central cluster.

  6. If you are restoring from external storage:

    1. Connect to the external backup storage using sudo tos backup storage set. with the <LOCATION> as external.

    2. Run sudo tos backup list to list all the backups and identify the one that you want to restore.

    3. Run sudo tos restore specifying the desired backup. We recommend that you select the most recent backup. On completion, your data will have been restored.

    4. Reinstall your license file.

    If you are restoring from a backup that was saved locally and transferred to a safe, external location:

    1. Copy the export file (gzip format) from the remote location to your primary data node.

    2. Run sudo tos backup import, specifying the full path of the export file, to extract all the backups from the export file to the TOS backup directory.

    3. Run sudo tos backup list to list all the backups and identify the one that you want to restore.

    4. Run sudo tos restore specifying the desired backup. We recommend that you select the most recent backup. On completion, your data will have been restored.

    5. Reinstall your license file.

    Important. After restoring from a backup in a production environment, the Site type appears as Lab in the Tufin Customer Portal. You must reinstall the license file; otherwise, TOS Aurora deactivates after 30 days. This isn’t required for lab environments.

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

      [<ADMIN> ~]$ tos status
      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 for a central cluster data node:

      [<ADMIN> ~]$ tos status         
[Mar 28 13:42:09]  INFO Checking cluster health status           
TOS Aurora
Tos Version: 24.2 (PRC1.1.0)

System Status: "Ok"
            
Cluster Status:
   Status: "Ok"
   Mode: "Multi Node"

Nodes
  Nodes:
  - ["node1"]
    Type: "Primary"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 19%
  - ["node3"]
    Type: "Worker Node"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 4%

registry
  Expiration ETA: 819 days
  Status: "Ok"

Infra
Databases:
- ["cassandra"]
  Status: "Ok"
- ["kafka"]
  Status: "Ok"
- ["mongodb"]
  Status: "Ok"
- ["mongodb_sc"]
  Status: "Ok"
- ["ongDb"]
  Status: "Ok"
- ["postgres"]
  Status: "Ok"
- ["postgres_sc"]
  Status: "Ok"

Application
Application Services Status OK
Running services 50/50

Remote Clusters
Number Of Remote Clusters: 2
  - ["RC"]
     Connectivity Status:: "OK:"
  - ["RC2"]
     Connectivity Status:: "OK"

  Backup Storage:
  Location: "Local
s3:http://minio.default.svc:9000/velerok8s/restic/default "
  Status: "Ok"
  Latest Backup: 2024-03-23 05:00:34 +0000 UTC

      Example output for a remote cluster data node:

      [<ADMIN> ~]$ tos status         
[Mar 28 13:42:09]  INFO Checking cluster health status           
TOS Aurora
Tos Version: 24.2 (PRC1.0.0)

System Status: "Ok"
            
Cluster Status:
   Status: "Ok"
   Mode: "Single Node"

Nodes
  Nodes:
  - ["node2"]
    Type: "Primary"
    Status: "Ok"
    Disk usage:
    - ["/opt"]
      Status: "Ok"
      Usage: 19%
  
registry
  Expiration ETA: 819 days
  Status: "Ok"

Infra
Databases:
- ["mongodb"]
  Status: "Ok"
- ["postgres"]
  Status: "Ok"

Application
Application Services Status OK
Running services 16/16

  Backup Storage:
  Location: "Local
s3:http://minio.default.svc:9000/velerok8s/restic/default "
  Status: "Ok"
  Latest Backup: 2024-03-23 05:00:34 +0000 UTC

    1. Reinstall all extensions. See the Extensions Knowledge Center.

    2. Reinstall all Professional Services solutions and reconfigure the cron jobs.