Upgrade TufinOS 3 to 4: New, VMWare ESXi, Central/Remote Cluster, TOS Reinstall

Overview

This procedure is for upgrading TufinOS 3 to 4 on new VMWare ESXi machines. 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-1
Single data node central clusters or remote clusters
Upgrades on new VMWare ESXi machines

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

Prerequisites

General Requirements

This procedure must be performed by an experienced Linux administrator with knowledge of network configuration.
If you have made a previous unsuccessful attempt to install TOS Aurora, you must uninstall and reboot before reinstalling (see Uninstalling TOS)
You cannot use IP Tables with TOS Aurora. In addition, all IP Tables rules will be flushed when installing.
Your servers must have sufficient CPUs, disk storage and main memory for TOS Aurora to work effectively. The resources required can be categorized by system size.

To evaluate the size of system you need, see Sizing Calculation for a Clean Install.

All resources need to be dedicated to the TOS Aurora machine. Do not use shared CPU or memory and if the datastore is shared, the disk performance must meet the requirements at all times.
Do not install any software on your server before or after the deployment of TOS Aurora that is not specified in the current procedure.

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.
Once TOS Aurora has been installed, changing the host name or IP address will require reinstalling - see Changing IP Address/Host Names. If you want to change the host name of the node, do so before running the tos install command.

If you need assistance, consult with your sales engineer or Tufin support.
Tufin Orchestration Suite should be treated as high-risk security resource, similar to how you would treat any LDAP product (for example, Active Directory). Therefore, you should only install Tufin Orchestration Suite in an appropriately secured network and physical location, and only authorized users should be granted access to TOS products and the operating system on the server.
If you are using NFS, your backup server needs to be running NFS 4.

If you have any external disks (for example, etcd), disconnect them. These disks should be reconnected after the TufinOS upgrade is complete.

VMware Requirements

Your ESX host must be running VMware ESXi 6.5, 6.7, 7.0 or 8.0 only. ESXi 8.0 requires TufinOS 4.20 or later

ESXi 6 is already EOL (end of life). ESXi 7 is planned to reach EOL in April 2025

Network Requirements

You must allow access to required Ports and Services.
Allocate a 24-bit CIDR subnet for the Kubernetes service network and a16-bit CIDR subnet for the Kubernetes pods network (10.244.0.0/16 is used by default).

The pods and services networks must be inside the following private networks: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16. In addition, ensure that the dedicated CIDR for the service network and pods network don't overlap with:
- Each other
- The physical addresses of your TOS Aurora servers (see below)
- Your primary VIP, Syslog VIP or external load balancer IP (see below)
- Any other subnets communicating with TOS or with TOS nodes
If a proxy is configured on your system make sure this network is excluded.
You must have available the following dedicated IP addresses:
- For on-premise deployments, a primary VIP that will serve as the external IP address used to access TOS Aurora from your browser. The primary VIP will not be needed in the installation of the operating system, except in the final step - the installation command.
- The physical network IP address of the first network interface used by the administrator for CLI commands. This is the IP address you will use in most steps of the procedure.
- If additional nodes are subsequently added to the cluster, each node will require an additional dedicated physical network IP address.
- Additional syslog VIPs can be allocated as needed.
- The VIP, all node physical network IP addresses and all syslog VIPs must be on the first network interface.
- Make sure your first physical interface is correctly configured and all other interfaces are not on the same network.
  
  To find the first network interface, run the following 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 }'
  Otherwise network errors such as connectivity failures and incorrect traffic routing might occur.
You must have a DNS server that can resolve its own address using a reverse lookup.

Downloads

Download the TufinOS 4.40 installation package from the Download Center.
Download the TOS R24-1 PHF4.0.0 installation package from the Download Center.

The downloaded files are in .tgz format <FILENAME>.tgz.

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.40-4368238-x86_64-Final.iso
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

Verify that your deployment is compatible with TufinOS 4.40.
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.40 and verify that you can perform the procedure.

Check the cluster health.

On the primary data node, check the following status.
```
[<ADMIN> ~]$ sudo systemctl status k3s
```
sudo systemctl status k3s

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

On the same node or nodes, check the TOS status.
```
[<ADMIN> ~]$ sudo tos status
```
sudo tos status

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

Backup your TOS data. 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. 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. Run the following command to display the list of backups saved on the node:
  [<ADMIN> ~]$ sudo tos backup list
  
  sudo tos backup list
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>
Remote Collector clusters. 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
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
Save your TufinOS Configuration (repeat this step for each node).

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.

Install TufinOS

TufinOS on the new data nodes, and on all worker nodes.

Place the TufinOS ISO image file on the datastore of vSphere. For local installation on a VMware machine, locate the extracted ISO image file.
Confirm that in your virtual machine settings, Boot Options is configured to use BIOS. If you are using EFI, the procedure will not work.
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.
Set the VM to boot to BIOS configuration
Example using vSphere
1. Navigate to VM settings > VM options.
2. Check: During the next boot, force entry into the BIOS setup screen.
In BIOS > Boot, select CD-ROM Drive.

In BIOS > Exit, select Exit Saving Changes. Click Yes.
Save the settings.
Restart the VM. TufinOS installation begins.
Select TufinOS 4.40 Installation for TOS Aurora.
When prompted, select which type of node to install:
- Install TufinOS 4.40 for Data Node.
- Install TufinOS 4.40 for Worker Node
When prompted, confirm and choose Yes.
When the installation is complete, reboot the virtual machine.
When BIOS launches, change the Boot option to Hard Drive.
In BIOS > Exit, select Exit Saving Changes. Click Yes.
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

Set Up The Nodes

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.
If you want to reset the host name or IP of the machine, do so now. Once TOS Aurora has been installed, changing the host name or IP address will require reinstalling - see Changing IP Address/Host Names. To change the host name, use the command below, replacing <mynode> with your preferred name:
```
[<ADMIN> ~]$ sudo hostnamectl set-hostname <mynode>
```
sudo hostnamectl set-hostname <mynode>
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
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.
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.
To find the first network interface
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 }'
To assign a static IP address or restore one that was used before upgrading:
1. Run the command:
2. Restart the network service.
Verify that the DNS server can resolve its own address using a reverse lookup
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
```

Mount The etcd Database on The Data Node to a New Disk

The etcd database should be on a separate disk to improve the stability of TOS Aurora and reduce latency. Moving the etcd database to a separate disk ensures that the kubernetes database has access to all the resources required to ensure an optimal TOS performance.

See Move etcd - New Non-Cloud VM.

Install TOS

TOS needs to be the same version that is running on the existing servers.

Run the tmux command:
```
[<ADMIN> ~]$ tmux new-session -s TOS-Install
```
tmux new-session -s TOS-Install
On the target machine, create the directory /opt/tufin/data, if it does not exist already.
Transfer the run file (already downloaded) to the /opt/tufin/data directory.
Go to /opt/tufin/data
Verify the integrity of the TOS installation packages by entering the following commands and comparing the output with the checksum information.

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

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

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

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

Run the TOS Aurora run file.

[<ADMIN> ~]$ cd /opt/misc/

cd /opt/misc/

[<ADMIN> ~]$ sudo sh <runfile>

sudo sh <runfile>

Run the install command, replacing the parameters:
- <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
- <MODULE-TYPE> - One of the following values:
  - ST for SecureTrack only
  - ST, SC for both SecureTrack and SecureChange/SecureApp
  - RC for a remote collector
- <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
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.
You can now safely exit the CLI screen session:
```
[<ADMIN> ~]# exit
```
exit
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.

Add The Worker Nodes to The Cluster

Repeat these steps for each worker node.

Add the worker node to the cluster.
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.

Check the cluster status.

On the primary data node, check the TOS status.
```
[<ADMIN> ~]$ sudo tos status
```
sudo tos status
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.

Example output:

[<ADMIN> ~]$ sudo tos status
          
[Mar 28 13:42:09]  INFO Checking cluster health status
           
TOS Aurora
            
System Status: "Ok"
            
Cluster Status:
   Status: "Ok"
   Mode: "Single Node"
   Nodes:
   - ["tufinos"]
     Type: "Primary"
     Status: "Ok"
     Disk usage:
     - ["/opt"]
       Status: "Ok"
       Usage: 55%
           
Databases:
- ["cassandra"]
  Status: "Ok"
- ["kafka"]
  Status: "Ok"
- ["mongodb"]
  Status: "Ok"
- ["mongodb_sc"]
  Status: "Ok"
- ["ongDb"]
  Status: "Ok"
- ["postgres"]
  Status: "Ok"
- ["postgres_sc"]
  Status: "Ok"
 
Backup Storage:
   Location: "Local s3:http://minio.default.svc:9000/velerok8s/restic/default "
   Status: "Ok"
   Last compatible healthy backup Timestamp: 2024-03-23 05:00:34 +0000 UTC
            
Registry:
   Expiration ETA: 637 days
   Status: "Ok"

Backup and Restore TOS Data

You are going to be backing up your TOS data on the existing data node and restoring it to the new data node.

Back up your TOS data.
Backup your TOS data. 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.

Create the backup using tos backup create:

[<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"

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

[<ADMIN> ~]$ sudo tos backup status

sudo tos backup status

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

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

[<ADMIN> ~]$ sudo tos backup list

sudo tos backup list

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"

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

If your backup files are saved locally:

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.

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>
Restore TOS to the new data node
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.
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.
Important. After you restore TOS to a different or changed production environment, such as a new appliance or VM, or an in-place machine following an operating system upgrade, you must upload the license file. If you are restoring to a lab environment, there is no need to upload the license file. TOS will be fully functional and in 'lab mode' . TOS will then automatically shut down after 30 days.

Check the cluster status.

On the primary data node, check the TOS status.
```
[<ADMIN> ~]$ sudo tos status
```
sudo tos status
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.

Example output:

[<ADMIN> ~]$ sudo tos status
          
[Mar 28 13:42:09]  INFO Checking cluster health status
           
TOS Aurora
            
System Status: "Ok"
            
Cluster Status:
   Status: "Ok"
   Mode: "Single Node"
   Nodes:
   - ["tufinos"]
     Type: "Primary"
     Status: "Ok"
     Disk usage:
     - ["/opt"]
       Status: "Ok"
       Usage: 55%
           
Databases:
- ["cassandra"]
  Status: "Ok"
- ["kafka"]
  Status: "Ok"
- ["mongodb"]
  Status: "Ok"
- ["mongodb_sc"]
  Status: "Ok"
- ["ongDb"]
  Status: "Ok"
- ["postgres"]
  Status: "Ok"
- ["postgres_sc"]
  Status: "Ok"
 
Backup Storage:
   Location: "Local s3:http://minio.default.svc:9000/velerok8s/restic/default "
   Status: "Ok"
   Last compatible healthy backup Timestamp: 2024-03-23 05:00:34 +0000 UTC
            
Registry:
   Expiration ETA: 637 days
   Status: "Ok"