Clean Install of TOS Aurora on Azure

Overview

This procedure is for the clean installation of TOS Aurora on the Azure platform, including setting up the AzureVM . To add a node to an existing cluster, start with multi-node cluster.For all other installation and upgrade options, see Installing and Upgrading.

Tufin Orchestration Suite (TOS Aurora) includes SecureTrack, SecureChange and SecureApp. You will specify the applications you want to enable, when you run the install command.

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.

After the installation you will have created a single data node TOS cluster to which you can add additional worker nodes. There is no need to install TOS on any additional nodes. Worker nodes require an operating system only.

High Availability (HA)

High availability is not supported in this release.

Remote Collectors (RCs)

Remote collectors can be deployed on Azure.

Prerequisites

General Requirements

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

  • To ensure optimal performance and reliability, the required resources need to always be available for TOS. If resources become unavailable, this will affect TOS performance. Do not oversubscribe resources.

  • Verify that you have sufficient resources (CPUs, disk storage and main memory) to run TOS Aurora. The required resources are determined by the size of your system. See Sizing Calculation for a Clean Install.

  • IP tables version 1.8.5 and above. IP tables must be reserved exclusively for TOS Aurora and cannot be used for any other purpose. During installation, any existing IP tables configurations will be flushed and replaced.

  • If you have made a previous unsuccessful attempt to install TOS Aurora, you must uninstall and reboot before reinstalling (see Uninstalling TOS)

  • The TOS installation removes all TOS files, directories and backups left on the machine from old deployments. If you have any files you want to keep, move them to a safe external location before starting this procedure.

  • Do not install any software on your server before or after the deployment of TOS Aurora that is not specified in the current procedure.

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

  • Large deployments are not supported on Azure.

Operating System Requirements

  • OS distribution:

    • Red Hat Enterprise Linux 8.10

    • Rocky Linux 8.10

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

  • The iptables must be 1.8.6 or later.

  • 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 external load balancer IP(s)

    • Any other subnets communicating with TOS or with TOS nodes

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

    • The system will use a reverse DNS lookup (PTR record) to resolve the DNS IP addresses with the domain name during the TOS installation. Therefore you have to add these PTR records to the DNS server. If you do not, the TOS installation will fail.

  • You need to configure a separate partition for /opt, a separate disk for etcd, and the OS disk needs at least 300 GB of available storage. The /opt partition will contain your data, which will increase over time. Most of your available disk space should be allocated to this partition and the minimum is determined by the load model parameter (small, medium, large) provided by your account team.

    Minimum sizes for all partitions:

    • OS disk: 300 GB

    • /opt/ (small): 80 GB

    • /opt/ (medium): 170 GB

    • /opt/ (Large): 370 GB

    • etcd: 128 GB

    *Small, medium and large refer to the load model parameter provided by your account team.

    We recommend allocating /opt partition all remaining disk space after you have partitioned the OS disk and moved etcd to a separate disk.

  • If you are using NFS, your backup server needs to be running NFS 4.

Procedure

Read and understand Prerequisites before you start.

Download and extract the installation package (see Downloads section above).

Follow the steps below in sequence.

For additional help, refer to the Microsoft Azure official documentation - Create a Linux virtual machine in the Azure portal

  1. Log in to your Azure portal.

  2. Navigate to Marketplace and create a VM.

  3. Under the Basics tab, enter/select the following information:

    • Subscription - your Azure subscription name

    • Resource Group - your Azure resource group name

    • Virtual Machine Name - a name of your choice to identify the VM e.g. myVirtualMachine-0

    • Region - select from the list

    • Image - select one of the following from the list:

      • Red Hat Enterprise Linux 8.10

      • Rocky Linux 8.10

      The image must include Logical Volume Management (LVM), which is required to enlarge the volumes.

    • Size - select CPUs and memory as advised by your account team

    • Authentication type - select SSH public key

    • User name - enter azureuser

    • SSH public key source - select generate new key pair

    • Key pair name - use the default name provided

  4. Under the Disks tab, enter/select the following information

    • OS disk type - select Premium SSD
    • Encryption - default

  5. Select Create and attach a new disk.

  6. Enter the disk details:

    • Enter a Name of your choice.

    • Set Host caching to Read/write.

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

    • Set Storage Size GiB to the disk space sizing requirement given to you by your account team.

  7. Save the disk defintions.

  8. If you want a public IP:

    • Select the Networking tab
    • Under Public IP, click Create new.
    • Enter a name.
    • Select SKU - Standard.

  9. Under the Tags tab, create two tags, replacing <your name> and <your environment name> with names of your choice:

    • owner: <your name>
    • env: <your environment name>
  10. Click Review and Create
  11. Click Create. The generate new key pair prompt appears.
  12. Generate a new key pair. Click Download private key and create resource. The private key will be downloaded to your PC as a file with suffix .pem. It will be needed to log into the VM console.

  13. Navigate to the directory on your PC that contains the .pem file just downloaded (<pem_key_name>) and change its permissions to prevent other users from running it.

    If your PC is running on a Linux-like operating system:

    [<ADMIN> ~]# chmod 400 <pem_key_name>
    chmod 400 <pem_key_name>

  14. You can now log in to the VM console whenever required.

    Log in to the Azure VM console where <pem_key_name> is the name of the .pem file downloaded previously from the Azure portal, <azureuser> is the name of your Azure user on the VM and <IP> is its private or public IP. The private and optional public IPs can be seen on the Networking tab.

    [<ADMIN> ~]# ssh -i <pem_key_name> <azureuser>@<IP>
    ssh -i <pem_key_name> <azureuser>@<IP>
  15. In the portal, select the newly created VM and then select the Networking tab.

  16. Select Add inbound port rule and create a rule with the properties below:

    • Source: Any
    • Source port ranges: *
    • Destination: Any
    • Destination port ranges: 31443, 31617, 31514, 31099, 31843, 30161, 30514, 31161 - see Ports and Services to see why
    • Protocol: Any
    • Action: Allow
    • Priority: 310
    • Name: TOS_Aurora or other name of your choice
    • Description: TOS_Aurora or other description of your choice

For additional help, refer to the MicrosoftAzure official documentation - Create a public load balancer to load balance VMs using the Azure portal and Configure port forwarding in Azure Load Balancer using the portal

  1. Log in to your Azure portal.

  2. Navigate to Load Balancers.

  3. Select Create. The Create load balancer window appears.

  4. Enter the following details:

    • Resource Group - the Azure resource group specified for your VM
    • Name - a suitable name for the load balancer
    • Type: Public if you want a public IP address, otherwise Internal.
    • SKU: Standard
    • Public IP address: (When type is Public). This is different from the public IP address of your VM. If you already have an IP address for the load balancer, select Use existing and enter the IP, otherwise leave the default Create new.
    • Public IP address name : (When type is Public). Enter a suitable name to refer to the public IP address.
    • IP Address Assignment: (When type is Internal). Select Dynamic.
    • Availability zone: Select Zone redundant.

    • Tags. Specify two tags, replacing <your name> and <your environment name> with names of your choice. It is recommended to use the same values used for your VM:

      • owner: <your name>
      • env: <your environment name>

    Leave the default values for all other fields.

    Click Create.

  5. Select the load balancer you just created.
  6. Select Overview and note the public IP address; you will need this shortly.

  7. Configure the load balancer backend pool:

    1. Select Backend pools.
    2. Select Add. The Add backend pool window appears.

    3. Enter details:

      • Name - a suitable name of your choice for the backend pool
      • Virtual Network - your virtual network
      • Virtual Machines - add the VM you created previously

    4. Click Add at the bottom of the page. The pool will be added.

  8. Configure the load balancer health probe:

    1. Select Health Probes.
    2. Select Add. The Add health probe window appears.

    3. Enter details:

      • Name - a suitable name of your choice for the health probe
      • Protocol: TCP
      • Port: 31443
      • Interval: 5
      • Unhealthy threshold: 2

    4. Click Add at the bottom of the page. The health probe will be added.

  9. Configure load balancing rules:

    1. Select Load Balancing Rules.
    2. Select Add The Add load balancing rule window appears.

    3. Add a load balancing rule with the following values:

      • Name: Any name of your choice
      • Frontend IP address: Enter the public IP address of the loadbalancer, noted above from the overview
      • Protocol: TCP
      • Port: 443
      • Backend port: 31443
      • Backend pool: Select the backend pool added above
      • Health probe: Select the health probe added above
      • Leave other fields with their default values.

    4. Click Add at the bottom of the page. The rule will be added.

    5. Repeat steps b. to d. for additional load balancing rules, entering a suitable name for each, with protocol, port and backend port. All rules are listed below - see Ports and Services for more information.

      Protocol

      Source

      Target

      Purpose
      TCP 443 31443

      Mandatory
      TCP 61617 31617

      Remote collector connectivity
      TCP 9099 31099

      OPM devices
      TCP 8443 31843

      Remote collector connectivity

      TCP

      9090

      31090

      Remote collector connectivity

      TCP

      6514

      31514

      TCP syslogs
      UDP 514 30514

      UDP syslogs
      UDP 161 30161

      SNMP monitoring
      UDP 10161 31161

      SNMP monitoring
    6. Click OK.

If not done already, set up partitions according to the Prerequisites.

  1. If you are not currently logged in as user root, do so now.

    [<ADMIN> ~]$ su -
    su -

  2. If you want to change 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> ~]# hostnamectl set-hostname <mynode>
    hostnamectl set-hostname <mynode>

  3. Modify the environment path to run TOS CLI commands without specifying the full path (/usr/local/bin/tos). 

    [<ADMIN> ~]# echo 'export PATH="${PATH}:/usr/local/bin"' | sudo tee -a /root/.bashrc > /dev/null
    echo 'export PATH="${PATH}:/usr/local/bin"' | sudo tee -a /root/.bashrc > /dev/null

  4. Synchronize your machine time with a trusted NTP server. Follow the steps in Configuring NTP Using Chrony.

  5. Configure the server timezone.

    [<ADMIN> ~]# timedatectl set-timezone <timezone>
    timedatectl set-timezone <timezone>

    where <timezone> is in the format Area/Location. Examples: America/Jamaica, Hongkong, GMT, Europe/Prague. List the time-zone formats that can be used in the command.

    [<ADMIN> ~]# timedatectl list-timezones
    timedatectl list-timezones

  6. Upgrade the kernel:

    [<ADMIN> ~]# dnf upgrade
    dnf upgrade

  7. Disable SELinux:

    • If file /etc/selinux/config exists, edit and change the value of SELINUX to disabled:

      SELINUX=disabled
    • If the file doesn't exist or SELINUX is already set to disabled, do nothing.
  8. Reboot the machine and log in.

  9. Install Wireguard. This is needed to encrypt communication between nodes (machines) within the cluster. The wireguard version must match the operating version you are installing.

    10. [<ADMIN> ~]# sudo yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm https://www.elrepo.org/elrepo-release-8.el8.elrepo.noarch.rpm
    sudo yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm https://www.elrepo.org/elrepo-release-8.el8.elrepo.noarch.rpm
    [<ADMIN> ~]# sudo yum install kmod-wireguard wireguard-tools
    sudo yum install kmod-wireguard wireguard-tools
  10. Reboot the machine and log in.

  11. Install tmux and rsync:

    [<ADMIN> ~]# dnf install -y rsync tmux
    dnf install -y rsync tmux

  12. Disable the firewall:

    [<ADMIN> ~]# systemctl stop firewalld
    systemctl stop firewalld
    [<ADMIN> ~]# systemctl disable firewalld
    systemctl disable firewalld

  13. Create the TOS Aurora load module configuration file /etc/modules-load.d/tufin.conf. Example using vi:

    [<ADMIN> ~]# vi /etc/modules-load.d/tufin.conf
    vi /etc/modules-load.d/tufin.conf

  14. Specify the modules to be loaded by adding the following lines to the configuration file created in the previous step. The modules will then be loaded automatically on boot.

    br_netfilter
    wireguard
    overlay
    ebtables
    ebtable_filter
    br_netfilter wireguard overlay ebtables ebtable_filter

  15. Load the above modules now:

    [<ADMIN> ~]# cat /etc/modules-load.d/tufin.conf |xargs modprobe -a 
    cat /etc/modules-load.d/tufin.conf |xargs modprobe -a

    Look carefully at the output to confirm all modules loaded correctly; an error message will be issued for any modules that failed to load.

  16. Check that Wireguard has loaded correctly. 

    [<ADMIN> ~]# lsmod |grep wireguard
    lsmod |grep wireguard

    The output will appear something like this:

    wireguard              201106  0
ip6_udp_tunnel         12755  1 wireguard
udp_tunnel             14423  1 wireguard

    If Wireguard is not listed in the output, contact support.

  17. Create the TOS Aurora kernel configuration file /etc/sysctl.d/tufin.conf. Example using vi:

    [<ADMIN> ~]# vi /etc/sysctl.d/tufin.conf
    vi /etc/sysctl.d/tufin.conf

  18. Specify the kernel settings to be made by adding the following lines to the configuration file created in the previous step. The settings will then be applied on boot. 

    net.bridge.bridge-nf-call-iptables = 1
    fs.inotify.max_user_watches = 1048576
    fs.inotify.max_user_instances = 10000
    net.ipv4.ip_forward = 1
    net.bridge.bridge-nf-call-iptables = 1 fs.inotify.max_user_watches = 1048576 fs.inotify.max_user_instances = 10000 net.ipv4.ip_forward = 1

  19. Apply the above kernel settings now:

    [<ADMIN> ~]# sysctl --system
    sysctl --system
For maximum security, we recommend only installing official security updates and security patches for your Linux distribution, as well as the RPMs specifically mentioned in this section.

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

  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-1 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-1-pga0.0-final-4577.run

  1. Run the TOS Aurora run file.

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

  2. You must have permissions to execute TOS CLI commands. Grant permissions as shown below or allow use of sudo command.

    [<ADMIN> ~]# chmod +x /usr/local/bin/tos
    chmod +x /usr/local/bin/tos

  3. Run the install command, replacing the parameters:

    • <MODULE-TYPE> with one of the following values:

      • ST for SecureTrack only
      • ST, SC for both SecureTrack and SecureChange
      • RC for a remote collector
    • <SERVICE-CIDR> with the CIDR you want TOS Aurora to use for the Kubernetes service network, as described in Prerequisites

    • <PODS-CIDR> (Optional) with 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> with the load-model parameter value obtained from your account team as described in Prerequisites.
    [<ADMIN> ~]$ sudo tos install --modules=<MODULE-TYPE> --primary-vip=external --services-network=<SERVICE-CIDR> --pod-network=<PODS-CIDR> --load-model=<LOAD> -d
    sudo tos install --modules=<MODULE-TYPE> --primary-vip=external --services-network=<SERVICE-CIDR> --pod-network=<PODS-CIDR> --load-model=<LOAD> -d

    Example:

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

  4. The EULA appears. After reading, enter 'q' to exit the document and then enter 'y' to accept the EULA and continue until the command completes.

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

    [<ADMIN> ~]$ exit
    exit

  6. Go to the TOS Aurora login page by going to the URL of the load balancer DNS in your browser. You can see it in the AWS console by selecting the load balancer, looking under Description at the section Basic Configuration. There you can copy the DNS name and paste it into your browser.

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

Post-Install Configuration

SSL Certificates

Secured connections to TOS Aurora require a valid SSL certificate. Such a certificate is generated during the installation. It is automatically renewed when it expires and also when upgrading to later versions of TOS Aurora. When connecting for the first time after certificate renewal, you will be prompted to accept the new certificate. You can also use your own CA signed certificate, but such certificates will not be renewed automatically.

SAN Certificates

For every FortiManager device you intend to monitor, add a SAN signed certificate.

License Activation

Relevant only for central clusters, skip for remote collectors.

After the license is activated, have all TOS users enable the automatic license mechanism in their browser. For more information, see Site Usage Monitoring.

Using Syslog for Accountability and More

To include accountability and rule usage information in TOS Aurora you must configure your devices to send syslogs. For more information see Sending Additional Information via Syslog.

Adding Worker Nodes to Your Cluster

TOS Aurora is deployed as a single node Kubernetes cluster. See Multi-Node Cluster for more information about adding additional nodes.

Setting up External Backups

We recommend setting up backups on external storage.

Setting up Scheduled Backups

We recommend creating a backup policy as soon as possible.

DR (Disaster Recovery)

To setup TOS redundancy across sites, see Disaster Recovery.

Sending Cluster Health Status to Tufin

Enabled by default, system information is sent periodically to Tufin Support for the purpose of troubleshooting and identifying performance issues. It can be disabled (see Sending Cluster Health Status). The information includes:

  • DB status and size

  • Backup status

  • Kubernetes status and metrics

  • CPU metrics

  • Memory status

  • I/O

It does not include IP addresses, personal user information, or device information. All the information sent is encrypted and is accessible only to Tufin support teams.

The information is sent to Tufin from TOS users' browsers to the Tufin sub-domain mailbox.tufin.com, therefore requests from user browsers to this sub-domain must be allowed.

TOS Monitoring

TOS Monitoring lets you monitor the status of the TOS cluster and its nodes by generating a notification whenever a change in status occurs, such as a node failing, or a usage threshold reached, such as CPU or disk usage. We recommend that you set up TOS notifications in TOS Monitoring (see TOS Monitoring).

Additional Configuration

A number of additional parameters can be set now or later e.g. session timeout and SNMP - see Configuring TOS.

SecureChange Settings

Relevant only for central clusters; skip for remote collectors.

If you have installed SecureChange:

  1. Go into SecureChange by one the following means:

    • Sign in to TOS with the URL given previously and then select SecureChange from the app launcher.

    • Sign in directly to SecureChange by entering https://<IP>/tufinapps/securechange in the browser.

  2. Configure the DNS.

    1. Go to Settings > Miscellaneous.

    2. Delete the default value that appears in the field Server DNS name. Enter a value for Server DNS name - the DNS server to use for links in email notifications. This can be an IP address in the format 11.22.33.44 or a FQDN in the format https://mydomain.com. The SecureChange DNS name is published by SecureChange so it can be accessed from external sources. For example, it is embedded in notification mails sent by SecureChange, which include a link to a ticket, such as an email notifying a handler assigned with a task, or informing a requester that the ticket has been successfully resolved.

  3. Additional setup that can be done now or later:

    • Internal SSO Authentication. Internal SSO is enabled by default when TOS is installed, giving user access to all TOS components using the same credentials - SecureTrack, SecureChange, SecureApp, and extensions. When disabled, there is no connection between a SecureTrack user and SecureChange user with the same name.
    • Mail server connection
    • LDAP directory connection to use LDAP user accounts
    • Local users and user roles
    • Subsequent password changes can be made from the command line , see SecureChange Command Line Reference.

    • Change access to SecureTrack from SecureChange

      1. Go to Settings > SecureTrack:

      2. Change the default SecureTrack administrator. For SecureChange to access SecureTrack data, a SecureTrack administrator must be specified. By default this is the predefined user 'Admin' and everything will work fine if you leave it as it is. However, if you want a different user, create a new administrator and enter the user name. If you have already configured multi-domain management, this user can be either a super administrator or multi-domain administrator, depending on whether you want to restrict the administrator to selected domains.

      3. Remove link to SecureTrack . By default you can go from SecureChange to SecureTrack by selecting the SecureTrack link in the app launcher. If you want to remove this option, unmark the checkbox.

      4. Change connection check interval. The default value for the frequency of SecureChange testing connectivity to SecureTrack can be changed if desired.

      5. Click Test connection to verify that SecureChange has a connection to SecureTrack.

      6. Click Refresh license status. This will ensure that SecureTrack and SecureChange share the highest level of connectivity.

      7. Click Save.