Clean Install of TOS Aurora on GCP

Overview

This procedure is for the clean installation of TOS Aurora on Google Cloud Platform (GCP). To add a node to an existing cluster, see Adding a Node on GCP. 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. This node is the primary data node, and there is no need to install TOS on any additional nodes. Worker nodes require an operating system only, and with high availability, data is replicated between the nodes.

UDP traffic is not supported in GCP. To use UDP traffic, instead of creating a load balancer in GCP, you will create the load balancer when installing TOS using built-in software.

High Availability (HA)

High availability is supported for GCP over three availability zones, giving you a higher level of resilience and availability when deploying on this cloud platform. Note that all availability zones must be in the same region. See High availability.

Remote Collectors (RCs)

Remote collectors can be deployed on GCP. They are supported in and between different GCP regions.

Prerequisites

You must know the resources you will need - CPU cores, RAM, disk space and the load-model parameter <LOAD>, provided by your account team, based on the procedure Calculate resources - 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.
You will need to 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
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.

You will need to configure three partitions: /opt, /tmp and /var, as well as a separate disk for etcd. 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:

Minimum Partition Sizes

/opt/

(Small)*

/opt/

(Medium)*

/opt/

(Large)*

/tmp/

/var/

etcd

Central cluster / remote cluster primary data node / HA data nodes

80 GB

170 GB

370 GB

25 GB

200GB

128 GB

Worker node (central and remote clusters)

70 GB

25 GB

60 GB

N/A

*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 other directories.

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

See the Important Installation Information in the R24-1 Release Notes.

Downloads

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

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

Procedure

Follow the steps in sequence.

Launch the Instance
For additional help, refer to the official documentation Create and start a VM instance.
1. In the Google Cloud console, navigate to Compute Engine > VM instances
2. Click +CREATE INSTANCE.
3. Configure:
  - Name:
  - Region/Zone: As appropriate
  - Machine family: GENERAL-PURPOSE
  - Series: E2
  - Machine type: Custom
  - Cores / Memory: According to the load-model parameter value received from your account team.
4. Under Boot Disk, click CHANGE.
5. Configure the boot disk.
  - Make sure tab Public Images is selected.
  - Operating system: Red Hat Enterprise Linux or Rocky Linux
  - Version:
    
    Red Hat Enterprise Linux 8.6, 8.8, or 8.9
    
    Rocky Linux 8.6, 8.8, or 8.9
  - Boot disk type, SSD persistent disk
  - Size, The value received from your account team.
6. Click Select. The boot disk settings will be saved.
7. Select Advanced options.
8. Select Networking.
9. Configure Networking:
  - Network tags: default-allow-ssh allow-nginx-ingress
  - Hostname: Optional
10. (Optional) Host name: Type a host name or use the default device value.
11. Click CREATE.
Create a Firewall Rule for Traffic
Create a firewall rule to allow traffic to nginx nodeport and health checking

Leave default values for all parameters not mentioned.
1. Navigate to VPC Network > Firewall
2. Click +CREATE FIREWALL RULE
3. Configure:
  - Name: allow-nginx-ingress
  - Network: default
  - Direction: Ingress
  - Action: Allow
  - Targets: Specified target tags
  - Target tags: allow-nginx-ingress
  - Source filter: IPv4 ranges
  - Source IPv4 ranges: 0.0.0.0/0
  - Second sourced filter: None
  - Protocols and ports: Specified ports and protocols - TCP 31443
4. Click CREATE.

Create an Instance Group

For more information about managing instance groups, see the vendor documentation Group unmanaged VMs together.

Leave default values for all parameters not mentioned.

Navigate to Compute Engine > Instance groups
Click +CREATE INSTANCE GROUP.
Select New unmanaged instance group (not the stateless or stateful options).
Configure:
- Name:
- Location: As defined for your VM
- Network / Subnetwork: Same network used by the instance or Default
- VM Instances: Select the new VM created previously
Under Port mapping, click ADD PORT
Enter port details
- Name: https
- Number: 31443

Add additional TCP ports, by repeating the previous two steps, depending on the features you intend to use from the list below.

Port	Purpose	Cluster Type (Central cluster/Remote collector)
31099	OPM devices	Central cluster
31514	TCP syslogs	Central cluster
31422	Event Streaming	Central cluster/remote collector
8443	RC sync - Revisions and control	Remote collector
31617	JMS - configuration metrics and device statuses	Remote collector
31843	SecureTrack client	Central cluster (only if deploying remote collector)

Click CREATE. The instance group will be created.

Create a Health Check
Leave default values for all parameters not mentioned.
1. Navigate to Health checks.
2. Click +CREATE HEALTH CHECK.
3. Select/Enter values:
  - Name
  - Protocol: TCP
  - Port: 31443
4. Leave default values for health criteria, or change according to your requirements.
5. Click CREATE.

Create the Load Balancer.

The load balancer configuration depends on whether or not you will be using UDP traffic. If you are not using UDP traffic, follow the default configuration instructions.

Create the GCP Load Balancer - Default

After launching the instance, you need to create a separate load balancer for each of the ports you are going to need. These ports are listed in the Target column in the table below. Some ports are only needed if you are deploying a remote collector.

Protocol	Source	Target	Purpose	Cluster Type (Central Cluster/Remote Collectors)
TCP	443	31443	Mandatory. UI connectivity.	Central cluster
TCP	9099	31099	OPM devices	Central cluster
TCP	6514	31514	TCP syslogs	Central cluster/ Remote collector
TCP	8422	31422	Event streaming	Remote collector
TCP	9090	31090	Allows central cluster to receive data from remote collector cluster	Remote collector
TCP	31843	8443	RC sync - Revisions and control	Remote collector
TCP	61617	31617	JMS - configuration metrics and device statuses	Remote collector
TCP	8443	31843	SecureTrack client	Central cluster (only if deploying remote collector)

Repeat this step for each port in the table that you are going to need.

For more information, see the vendor documentation Set up the load balancer.

Leave default values for all parameters not mentioned.

Navigate to Network Services > Load balancing.
Click +CREATE LOAD BALANCER.
Under Network Load Balancer (TCP/SSL), click START CONFIGURATION.
Select the following options:
- Internet facing or internal only: Only between my VMs.
- Multiple regions or single region: Single region only
- Load Balancer type: Proxy
Click Continue.
Enter/Select the following information:
- Load Balancer name
- Region
- Network
Click Backend configuration.
In the Backend Configuration section, enter/select the following:
- Backend type: Instance group
- Protocol: TCP
- Named port: https (the name of the port you created for the instance)
- Timeout: 30
In the Instance Groups section, enter/select the following:
- Instance group: The instance group created previously
- Port numbers: The target port
- Health check: The health check created previously
In the New Frontend IP and port section, enter/select the following:

Name:
Subnetwork: The network you are using
IP address: The IP Address of the machine you want to send the traffic to
Port number: The source port

Click DONE.
Click CREATE.

Create the Metal LB Load Balancer - for UDP Traffic support
The Metal LB load balancer is configured when installing TOS using built-in software. This requires configuring an alias IP address.
1. Edit the VM instance.
2. Go to Networking > Network Interfaces.
3. In the Custom ephemeral IP Address field, add the primary VIP.
4. Add two Alias IP ranges for the load balancer VIP and syslog VIP.
  
  If you need additional syslog VIPs, add more alias IP ranges, For more information, see Syslog VIP Addresses.
Copy these VIP addresses to a separate location. You will need them when running the tos install command.

Create Firewall Rules
Repeat this step for each of the ports you open.

For more information, see the vendor documentation Create a new firewall rule.
1. Navigate to VPC Network > Firewall
2. Click CREATE FIREWALL RULE
3. Configure:
  - Name
  - Logs: Off
  - Network: Default
  - Priority: 1000
  - Direction of traffic: Ingress
  - Action on match: Allow
  - Targets: Specified target tags
  - Target tags: (example) syslog-ingress
  - Source filter: IPv4 ranges
  - Source IPv4 ranges: 0.0.0.0/0
  - Second source filter: None
  - Protocols and ports: Specified protocols and ports - UDP 30514
4. Click CREATE.
5. Navigate to VM instances and select the VM created previously
6. Click EDIT
7. Go to Network Tags and add the target tag specified above
Connect to the VM Using SSH
To connect via ssh you can add an existing ssh key to GCP via UI or use the gcloud utilily to generate key and add it.

To generate a key using gcloud:
1. Download gcloud to your workstation.
2. Run gcloud auth login command to login to your account. Variable <PROJECT_ID> can be set once globally to avoid entering it each time.
  gcloud config set project "<PROJECT_ID>"
  
  gcloud config set project "<PROJECT_ID>"
  gcloud compute ssh --zone "<ZONE>" "<VM_INSTANCE_NAME>"
  
  gcloud compute ssh --zone "<ZONE>" "<VM_INSTANCE_NAME>"
Configure Partitions

If not done already, set up partitions according to the Prerequisites.
Configure the Operating System
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. See Install Wireguard and follow the steps for your Linux distribution.
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.
Mount The etcd database on a separate volume

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. This will require some down time as you are going to have to shut down TOS before separating the disks.
Install TOS Aurora
Deploy the Install File
1. On the target machine, create the directory /opt/tufin/data, if it does not exist already.
2. Transfer the TOS installation package (still in archive format .tgz) to the /opt/tufin/data directory.
3. Switch to the target directory
  [<ADMIN> ~]$ cd /opt/tufin/data
  
  cd /opt/tufin/data
4. Verify the integrity of the TOS installation package by entering the following commands and comparing the output with the checksum information.
5. Extract the TOS run file from the archive.
  [<ADMIN> ~]$ tar -xvzf tos-xxxx-xxxxxxxx-final-xxxx.run.tgz
  
  tar -xvzf tos-xxxx-xxxxxxxx-final-xxxx.run.tgz
6. Run the TOS Aurora run file.
  [<ADMIN> ~]$ sudo sh <runfile>
  
  sudo sh <runfile>
7. 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
Start the Install
1. Run the tmux command:
  [<ADMIN> ~]$ sudo tmux new-session -s install
  
  sudo tmux new-session -s install
2. Run the install command, replacing the parameters:
  - <SERVICE-CIDR> with the CIDR you want TOS Aurora to use for the Kubernetes service network, as described in Prerequisites
  - <MODULE-TYPE> with one of the following values:
    
    ST for SecureTrack only
    
    ST, SC for both SecureTrack and SecureChange
    
    RC for a remote collector
  - <LOAD> with the load-model parameter value received from your account team as described in Prerequisites.
    
    [<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
  Example:
  
  # sudo tos install --modules=ST,SC --primary-vip=external --services-network=10.10.10.0/24 --load-model=medium -d
  
  If you will be using UDP traffic and created alias IP ranges earlier, the command should be as follows:
  tos install -–modules=<MODULE-TYPE> --primary-vip=<LOAD BALANCER VIP> --syslog-vip=<SECOND ALIAS IP> tos install --services-network=10.10.10.0/24 --load-model=medium -d
3. The EULA is displayed. After reading, enter 'q' to exit the document and then enter 'y' to accept the EULA and continue until the command completes.
4. You can now safely exit the CLI tmux session:
  [<ADMIN> ~]$ exit
  
  exit
5. Go to the TOS Aurora login page by going to the URL of the load balancer DNS in your browser.
6. 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.
- Tiered license: See Uploading License Files to TOS (Solution Tiers)
- Legacy license: Adding Licenses (Legacy Model)
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

You can use syslog to send accountability and other information from your devices to SecureTrack - see Sending Additional Information via Syslog. If you want to use this feature and you have installed TOS on-premise, you must also set up a Syslog VIP Address.

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.

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
    
    Go to Settings > SecureTrack:
    
    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.
    
    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.
    
    Change connection check interval. The default value for the frequency of SecureChange testing connectivity to SecureTrack can be changed if desired.
    
    Click Test connection to verify that SecureChange has a connection to SecureTrack.
    
    Click Refresh license status. This will ensure that SecureTrack and SecureChange share the highest level of connectivity.
    
    Click Save.

Clean Install of TOS Aurora on GCP

Overview

High Availability (HA)

Remote Collectors (RCs)

Prerequisites

Downloads

Procedure

Deploy the Install File

Start the Install

Post-Install Configuration

SSL Certificates

SAN Certificates

License Activation

Using Syslog for Accountability and More

Adding Worker Nodes to Your Cluster

Setting up External Backups

Setting up Scheduled Backups

DR (Disaster Recovery)

TOS Monitoring

Additional Configuration

SecureChange Settings