Fortinet black logo

Fresh Installation

This section describes how to install FortiSIEM for the current release.

Pre-Installation Checklist

Before you begin, check the following:

  • Ensure that your system can connect to the network. You will be asked to provide a DNS Server and a host that can be resolved by the DNS Server and responds to ping. The host can either be an internal host or a public domain host like google.com.
  • Choose deployment type – Enterprise or Service Provider. The Service Provider deployment provides multi-tenancy.
  • Determine whether FIPS should be enabled
  • Choose install type:
    • All-in-one with FortiSIEM Manager
    • Cluster with Manager, Supervisor and Workers
    • All-in-one with Supervisor only, or
    • Cluster with Supervisor and Workers
  • Choose the storage type for Supervisor, Worker, and/or Collector
    • Online - There are 4 choices
      • EventDB on local disk
      • EventDB on NFS
      • ClickHouse
      • Elasticsearch
    • Archive – There are 2 choices
      • EventDB on NFS
      • HDFS
  • Determine hardware requirements and choose the Azure instance type accordingly:
Node vCPU RAM Local Disks

Manager

Minimum – 16
Recommended - 32

Minimum

  • 24GB

Recommended

  • 32GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

Supervisor (All in one) Minimum – 12
Recommended - 32

Minimum

  • without UEBA – 24GB
  • with UEBA - 32GB

Recommended

  • without UEBA – 32GB
  • with UEBA - 64GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

Local Event database – based on need

Supervisor (Cluster) Minimum – 12
Recommended - 32

Minimum

  • without UEBA – 24GB
  • with UEBA - 32GB

Recommended

  • without UEBA – 32GB
  • with UEBA - 64GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

Workers Minimum – 8
Recommended - 16

Minimum – 16GB

Recommended – 24GB

OS – 25GB

OPT – 100GB

Collector Minimum – 4
Recommended – 8 ( based on load)

Minimum – 4GB

Recommended – 8GB

OS – 25GB

OPT – 100GB

  • If your Online event database is external (e.g. EventDB on NFS or Elasticsearch), then you must configure external storage before proceeding to FortiSIEM deployment.

    • For NFS deployment, see here.

    • For Elasticsearch deployment, see here.

  • If your Online event database is internal, that is, inside Supervisor or Worker nodes, then you need to determine the size of the disks based on your EPS and event retention needs.

    • For EventDB on local disk, see here.

    • For ClickHouse, see here.

  • For OPT - 100GB, the 100GB disk for /opt will consist of a single disk that will split into 2 partitions, /OPT and swap. The partitions will be created and managed by FortiSIEM when configFSM.sh runs.

All-in-one Installation

This is the simplest installation with a single Virtual Appliance. If storage is external, then you must configure external storage before proceeding with installation.

Find the FortiSIEM Offer in Azure Using the Azure Marketplace

  1. On the Azure portal, search for Marketplace and navigate to Azure Marketplace.

  2. Search for the keyword "fortisiem".

  3. Select the Create drop-down, and choose Fortinet FortiSIEM for Azure.

    At this point, Azure will take you through the steps to create a virtual machine by first taking you to the Create a virtual machine page. Follow the steps in Create a VM Using a FortiSIEM 6.5.1 Azure Marketplace Image to continue.

Create a VM Using a FortiSIEM 6.5.1 Azure Marketplace Image

From the Create a virtual machine page, take the following steps:

  1. From the Resource group drop-down list, select a resource group.

  2. In the Virtual machine name field, enter a name for your virtual machine.

  3. From the Image drop-down list, select the image.


  4. From the Size drop-down list, select a size based on your node type and hardware requirements.

  5. Under Administrator account, select SSH public key for Authentication type.

  6. The Username field is specified as azureuser.

  7. From the Key pair name drop-down list, select your existing key pair. If needed, generate a new key pair, then select it here.

  8. When done with this step for configuration , click Next: Disks >.

  9. On the Create a new disk page, you will need to create disks based on the following table.

    Volume Name Size Disk Name
    Data Disk LUN 0 100GB

    /opt

    For OPT - 100GB, the 100GB disk for /opt will consist of a single disk that will split into 2 partitions, /OPT and swap. The partitions will be created and managed by FortiSIEM when configFSM.sh runs.

    Data Disk LUN 1 60GB for FortiSIEM Supervisor
    or
    200GB for FortiSIEM Manager
    /cmdb
    Data Disk LUN 2 60GB /svn
    Data Disk LUN 3 60GB+ /data (see the following note)

    Note on Data Disk LUN 3:

    • Add the 4th Data Disk only if using EventDB on local storage or ClickHouse. In all other cases, this disk is not required.
    • For EventDB on local disk, choose a disk based on your EPS and event retention policy. See EventDB Sizing Guide for guidance. 60GB is the minimum.
    • For ClickHouse, choose disks based on the number of Tiers and disks on each Tier. These depend on your EPS and event retention policy. See ClickHouse Sizing Guide for guidance. For example, you can choose 1 large disk for Hot Tier. Or you can choose 2 Tiers - Hot Tier comprised of one or more SSD disks and Warm Tier comprised of one or more magnetic hard disks.
    • Choose Standard SSD volume type for all volumes. For the CMDB partition, you can choose to modify your volume type to Premium SSD or Ultra SSD based on your system workload if you see the consistently high IOPS requirement in your deployment.
    1. In the Name field, enter the name of the disk.

    2. In the Source type drop-down list, leave as None (empty disk).

    3. In the Size drop-down list, select Change size, select the Custom disk size (GiB) option, and enter the disk size in the available field.

    4. Click OK.

    5. For each new disk, click Create and attach a new disk and repeat steps a-d until all the necessary disks have been created.

  10. After entering your disk partition values, click Next: Networking >.

  11. From the Networking page (Networking tab), accept the defaults except for NIC network security groups. For production, choose Advanced and configure the required inbound ports and IP addresses (refer to Azure documentation).

  12. Click Next: Management >.

  13. From the Management page (Management tab), accept the defaults provided or change them as needed per the Azure documentation.

  14. Click Next: Monitoring.

  15. From the Monitoring page (Monitoring tab), under Diagnostics, select Enable with managed storage account (recommended).

    Click Next: Advanced >.


  16. Leave Advanced settings alone, and click Next: Tags >.

  17. From the Tags page (Tags tab), add a Name tag and any other tags as needed.

  18. Click Next: Review + create >.

  19. From the Review + create page tab, verify that all the information is correct. Click Create.


  20. If you chose to create a new SSH key, then you will be asked to download the private key and create the resource. Click Download private key and create resource.

  21. Wait for deployment to succeed. Click Go to resource.


  22. Note the Public IP address and copy it to the clipboard.

  23. (Optional) Configure the DNS name according to Azure documentation.

  24. SSH to the FortiSIEM VM with user azureuser (as specified here) and the downloaded SSH key. Run sudo su – to become user root. Run configFSM.sh.

Configure FortiSIEM

Follow these steps to configure FortiSIEM by using a simple GUI.

  1. At the root command prompt, go to /usr/local/bin and enter configFSM.sh, for example:

    # configFSM.sh

  2. In VM console, select 1 Set Timezone and then press Next.

  3. Select your Location, and press Next.

  4. Select your Continent, and press Next.

  5. Select the Country and City for your timezone, and press Next.

  6. If installing a Supervisor, select 1 Supervisor. Press Next.
    If installing a Worker, select 2 Worker, and press Next.
    If installing a Collector, select 3 Collector, and press Next.
    If Installing FortiSIEM Manager, select 4 FortiSIEM Manager, and press Next.
    If Installing FortiSIEM Supervisor Follower, select 5 Supervisor Follower and press Next.
    Note: The appliance type cannot be changed once it is deployed, so ensure you have selected the correct option.

    note icon

    Regardless of whether you select FortiSIEM Manager,Supervisor, Supervisor Follower, Worker, or Collector, you will see the same series of screens with only the header changed to reflect your target installation, unless noted otherwise.

  7. If you want to enable FIPS, then choose 2 install_with_fips. Otherwise, choose 1 install_without_fips. You have the option of enabling FIPS (option 3) or disabling FIPS (option 4) later. Note: After Installation, a 5th option to change your network configuration (5 change_network_config) is available. This allows you to change your network settings and/or host name.


  8. Determine whether your network supports IPv4-only, IPv6-only, or both IPv4 and IPv6 (Dual Stack). Choose 1 for IPv4-only, choose 2 for IPv6-only, or choose 3 for both IPv4 and IPv6.
  9. If you choose 1 (IPv4) or choose 3 (Both IPv4 and IPv6), and press Next, then you will move to step 10. If you choose 2 (IPv6), and press Next, then skip to step 11.

  10. Configure the IPv4 network by entering the following fields. Press Next.

    OptionDescription
    IPv4 AddressThe Manager/Supervisor/Worker/Collector's IPv4 address
    NetmaskThe Manager/Supervisor/Worker/Collector's subnet
    GatewayNetwork gateway address
    DNS1, DNS2Addresses of the DNS servers

  11. If you chose 1 in step 8, then you will need to skip to step 12. If you chose 2 or 3 in step 8, then you will configure the IPv6 network by entering the following fields, then press Next.

    Option Description
    IPv6 Address The Manager/Supervisor/Worker/Collector's IPv6 address
    prefix (Netmask) The Manager/Supervisor/Worker/Collector's IPv6 prefix
    Gateway ipv6 IPv6 Network gateway address
    DNS1 IPv6, DNS2 IPv6 Addresses of the IPv6 DNS server 1 and DNS server2

    Note: If you chose option 3 in step 8 for both IPv4 and IPv6, then even if you configure 2 DNS servers for IPv4 and IPv6, the system will only use the first DNS server from IPv4 and the first DNS server from the IPv6 configuration.

    Note: In many dual stack networks, IPv4 DNS server(s) can resolve names to both IPv4 and IPv6. In such environments, if you do not have an IPv6 DNS server, then you can use public IPv6 DNS servers or use IPv4-mapped IPv6 address.

  12. Configure Hostname for the FortiSIEM Manager/Supervisor/Worker/Collector. Press Next.


    Note: FQDN is no longer needed.

  13. Test network connectivity by entering a host name that can be resolved by your DNS Server (entered in the previous step) and responds to ping. The host can either be an internal host or a public domain host like google.com. In order for the migration to complete, the system still needs https connectivity to FortiSIEM OS update servers – os-pkgs-cdn.fortisiem.fortinet.com and os-pkgs-c8.fortisiem.fortinet.com. Then, click Next.
    Note: By default, “google.com” is shown for the connectivity test, but if configuring IPv6, you must enter an accessible internally approved IPv6 DNS server, for example: “ipv6-dns.fortinet.com"
    Note: When configuring both IPv4 and IPv6, only testing connectivity for the IPv6 DNS is required because the IPV6 takes higher precedence. So update the host field with an approved IPv6 DNS server.

  14. The final configuration confirmation is displayed. Verify that the parameters are correct. If they are not, then press Back to return to previous dialog boxes to correct any errors. If everything is OK, then press Run.

    The options are described in the following table.

    OptionDescription
    -rThe FortiSIEM component being configured
    -zThe time zone being configured
    -iIPv4-formatted address
    -mAddress of the subnet mask
    -gAddress of the gateway server used
    --hostHost name
    -fFQDN address: fully-qualified domain name
    -tThe IP type. The values can be either 4 (for ipv4) or 6 (for v6) or 64 (for both IPv4 and IPv6).

    --dns1, --dns2

    Addresses of the DNS server 1 and DNS server 2.

    --i6

    IPv6-formatted address

    --m6

    IPv6 prefix

    --g6

    IPv6 gateway

    -o

    Installation option (install_without_fips, install_with_fips, enable_fips, disable_fips, change_network_config*)
    *Option only available after installation.

    -zTime zone. Possible values are US/Pacific, Asia/Shanghai, Europe/London, or Africa/Tunis

    --testpinghost

    The URL used to test connectivity

  15. It will take some time for this process to finish. When it is done, proceed to Upload the FortiSIEM License. If the VM fails, you can inspect the ansible.log file located at /usr/local/fresh-install/logs to try and identify the problem.

Upload the FortiSIEM License

note icon

Before proceeding, make sure that you have obtained valid FortiSIEM license from Forticare. For more information, see the Licensing Guide.

You will now be asked to input a license.

  1. Open a Web browser and log in to the FortiSIEM UI. Use link https://<supervisor-ip> to login. Please note that if you are logging into FortiSIEM with an IPv6 address, you should input https://[IPv6 address] on the browser tab.
  2. The License Upload dialog box will open.

  3. Click Browse and upload the license file.

    Make sure that the Hardware ID shown in the License Upload page matches the license.

  4. For User ID and Password, choose any Full Admin credentials.

    For the first time installation, enter admin as the user and admin*1 as the password. You will then be asked to create a new password for GUI access.

  5. For Supervisor, Worker, or Collector, choose License type as Enterprise or Service Provider. The following option will be available for first time installations. Once the database is configured, this option will not be available.
    For FortiSIEM Manager, License Type is not an available option, and will not appear. At this point, FortiSIEM Manager installation is complete. You will not be taken the Event Database Storage page, so you can skip Configure an Event Database.
    Note: The FortiSIEM Manager license allows a certain number of instances that can be registered to FortiSIEM Manager.
  6. Proceed to Configure an Event Database.

Configure an Event Database

Choose the event database.

If the Event Database is one of the following options, additional disk configuration is required.

Final Check

FortiSIEM installation is complete. If the installation is successful, the VM will reboot automatically. Otherwise, the VM will stop at the failed task.

You can inspect the ansible.log file located at /usr/local/fresh-install/logs if you encounter any issues during FortiSIEM installation.

After installation completes, ensure that the phMonitor is up and running, for example:

# phstatus

For the Supervisor, Supervisor Follower, Worker and Collector, the response should be similar to the following.



For FortiSIEM Manager, the response should look similar to the following.

Cluster Installation

For larger installations, you can choose Worker nodes, Collector nodes, and external storage (NFS, ClickHouse, or Elasticsearch).

Install Supervisor

Follow the steps in All-in-one Installation, except with the following differences.

  1. Event Database choices are EventDB on NFS, ClickHouse, or Elasticsearch.

  2. If you choose EventDB on NFS

    1. Disk 4 is not required (From Create a VM Using a FortiSIEM 6.5.1 Azure Marketplace Image Step 8).

    2. You need to configure NFS after license upload.



  3. If you choose ClickHouse

    1. You need to create disks during Create a VM Using a FortiSIEM 6.5.1 Azure Marketplace Image Step 8 based on the role of the Supervisor node in the ClickHouse cluster. See the ClickHouse Sizing Guide for details.

    2. You need to configure disks after license upload.

  4. If you choose Elasticsearch, define Elasticsearch endpoints after license upload. See the Elasticsearch Sizing Guide for details.

Install Workers

Once the Supervisor is installed, take the same steps in All-in-one Installation to install a Worker with the following differences.

  1. Choose appropriate CPU and memory for the Worker nodes based on Sizing guide.

  2. Two hard disks for Operating Systems and FortiSIEM Application:

    • OS – 25GB

    • OPT – 100GB

      For OPT - 100GB, the 100GB disk for /opt will consist of a single disk that will split into 2 partitions, /OPT and swap. The partitions will be created and managed by FortiSIEM when configFSM.sh runs.

  3. If you are running ClickHouse, then create additional data disks based on the role of the Worker in ClickHouse topology. If it is a Keeper node, then a smaller disk is needed. If it is a data node, then a bigger disk is needed based on your EPS and retention policy. See ClickHouse Sizing Guide for details.

Sizing Guide References:

Register Workers

Once the Worker is up and running, add the Worker to the Supervisor node.

  1. Go to ADMIN > License > Nodes.
  2. Select Worker from the Mode drop-down list and enter the following information:

    1. In the Host Name field, enter the Worker's host name.

    2. In the IP Address field, enter the Worker's IP address.

    3. If you are running ClickHouse, then select the number for Storage Tiers from the Storage Tiers drop-down list, and input disk paths for disks in each Tier in the Disk Path fields.

    4. Click Test.

    5. If the test succeeds, then click Save.

  3. See ADMIN > Health > Cloud Health to ensure that the Workers are up, healthy, and properly added to the system.

Create ClickHouse Topology (Optional)

If you are running ClickHouse, you need to configure ClickHouse topology by specifying which nodes belong to ClickHouse Keeper and Data Clusters. Follow the steps in Configuring ClickHouse Topology.

Install Collectors

Once Supervisor and Workers are installed, follow the same steps in All-in-one Install to install a Collector except when adding disks, you need to only add a data disk for OPT. The recommended settings for Collector node are:

  • CPU = 4
  • Memory = 8GB
  • Two hard disks:
    • OS – 25GB
    • OPT – 100GB
      For OPT - 100GB, the 100GB disk for /opt will consist of a single disk that will split into 2 partitions, /OPT and swap. The partitions will be created and managed by FortiSIEM when configFSM.sh runs.

Register Collectors

Collectors can be deployed in Enterprise or Service Provider environments.

Enterprise Deployments

For Enterprise deployments, follow these steps.

  1. Log in to Supervisor with 'Admin' privileges.
  2. Go to ADMIN > Settings > System > Cluster Config.
    1. Enter the IP of the Worker node in the Event Upload Workers column. If a Supervisor node is only used, then enter the IP of the Supervisor node. Multiple IP addresses can be entered on separate lines. In this case, the Collectors will load balance the upload of events to the listed Event Workers.
      Note: Rather than using IP addresses, a DNS name is recommended. The reasoning is, should the IP addressing change, it becomes a matter of updating the DNS rather than modifying the Event Worker IP addresses in FortiSIEM.
    2. Click Save.
    3. In the Supervisors column, enter the IP of the Supervisor node and click Save.
  3. Go to ADMIN > Setup > Collectors and add a Collector by entering:
    1. Name – Collector Name
    2. Guaranteed EPS – this is the EPS that Collector will always be able to send. It could send more if there is excess EPS available.
    3. Start Time and End Time – set to Unlimited.
  4. SSH to the Collector and run following script to register Collectors:

    phProvisionCollector --add <user> '<password>' <Super IP or Host> <Organization> <CollectorName>

    The password should be enclosed in single quotes to ensure that any non-alphanumeric characters are escaped.

    1. Set user and password using the admin user name and password for the Supervisor.
    2. Set Super IP or Host as the Supervisor's IP address.
    3. Set Organization. For Enterprise deployments, the default name is Super.
    4. Set CollectorName from Step 2a.

      The Collector will reboot during the Registration.

  5. Go to ADMIN > Health > Collector Health for the status.

Service Provider Deployments

For Service Provider deployments, follow these steps.

  1. Log in to Supervisor with 'Admin' privileges.
  2. Go to ADMIN > Settings > System > Event Worker.
    1. Enter the IP of the Worker node. If a Supervisor node is only used, then enter the IP of the Supervisor node. Multiple IP addresses can be entered on separate lines. In this case, the Collectors will load balance the upload of events to the listed Event Workers.
      Note: Rather than using IP addresses, a DNS name is recommended. The reasoning is, should the IP addressing change, it becomes a matter of updating the DNS rather than modifying the Event Worker IP addresses in FortiSIEM.
    2. Click OK.
    3. In the Supervisors column, enter the IP of the Supervisor node and click Save.

  3. Go to ADMIN > Setup > Organizations and click New to add an Organization.

  4. Enter the Organization Name, Admin User, Admin Password, and Admin Email.
  5. Under Collectors, click New.
  6. Enter the Collector Name, Guaranteed EPS, Start Time, and End Time.

    The last two values could be set as Unlimited. Guaranteed EPS is the EPS that the Collector will always be able to send. It could send more if there is excess EPS available.

  7. SSH to the Collector and run following script to register Collectors:

    phProvisionCollector --add <user> '<password>' <Super IP or Host> <Organization> <CollectorName>

    The password should be enclosed in single quotes to ensure that any non-alphanumeric characters are escaped.

    1. Set user and password using the admin user name and password for the Organization that the Collector is going to be registered to.
    2. Set Super IP or Host as the Supervisor's IP address.
    3. Set Organization as the name of an organization created on the Supervisor.
    4. Set CollectorName from Step 6.

      The Collector will reboot during the Registration.

  8. Go to ADMIN > Health > Collector Health and check the status.

Install Manager

Starting with release 6.5.0, you can install FortiSIEM Manager to monitor and manage multiple FortiSIEM instances. An instance includes a Supervisor and optionally, Workers and Collectors. The FortiSIEM Manager needs to be installed on a separate Virtual Machine and requires a separate license. FortiSIEM Supervisors must be on 6.5.0 or later versions.

Follow the steps in All-in-one Install to install Manager. After any Supervisor, Workers, and Collectors are installed, you add the Supervisor instance to Manager, then Register the instance to Manager. See Register Instances to Manager.

Register Instances to Manager

To register your Supervisor instance with Manager, you will need to do two things in the following order.

Note that Communication between FortiSIEM Manager and instances is via REST APIs over HTTP(S).

Adding Instance to Manager

You can add an instance to Manager by taking the following steps.
Note: Make sure to record the FortiSIEM Instance Name, Admin User and Admin Password, as this is needed when you register your instance.

  1. Login to FortiSIEM Manager.

  2. Navigate to ADMIN > Setup.

  3. Click New.

  4. In the FortiSIEM Instance field, enter the name of the Supervisor instance you wish to add.

  5. In the Admin User field, enter the Account name you wish to use to access Manager.

  6. In the Admin Password field, enter the Password that will be associated with the Admin User account.

  7. In the Confirm Admin Password field, re-enter the Password.

  8. (Optional) In the Description field, enter any information you wish to provide about the instance.

  9. Click Save.

  10. Repeat steps 1-9 to add any additional instances to Manager.
    Now, follow the instructions in Register the Instance Itself to Manager for each instance.

Register the Instance Itself to Manager

To register your instance with Manager, take the following steps.

  1. From your FortiSIEM Supervisor/Instance, navigate to ADMIN > Setup > FortiSIEM Manager, and take the following steps.

    1. In the FortiSIEM Manager FQDN/IP field, enter the FortiSIEM Manager Fully Qualified Domain Name (FQDN) or IP address.

    2. If the Supervisor is under a Supervisor Cluster environment, in the FortiSIEM super cluster FQDN/IP field, enter the Supervisor Cluster Fully Qualified Domain Name (FQDN) or IP address.

    3. In the FortiSIEM Instance Name field, enter the instance name used when adding the instance to Manager.

    4. In the Account field, enter the Admin User name used when adding the instance to Manager.

    5. In the Password field, enter your password to be associated with the Admin User name.

    6. In the Confirm Password field, re-enter your password.

    7. Click Test to verify the configuration.

    8. Click Register.
      A dialog box displaying "Registered successfully" should appear if everything is valid.

    9. Login to Manager, and navigate to any one of the following pages to verify registration.

      • ADMIN > Setup and check that the box is marked in the Registered column for your instance.

      • ADMIN > Health, look for your instance under FortiSIEM Instances.

      • ADMIN > License, look for your instance under FortiSIEM Instances.

Install Log

The install ansible log file is located here: /usr/local/fresh-install/logs/ansible.log.

Errors can be found at the end of the file.

This section describes how to install FortiSIEM for the current release.

Pre-Installation Checklist

Before you begin, check the following:

  • Ensure that your system can connect to the network. You will be asked to provide a DNS Server and a host that can be resolved by the DNS Server and responds to ping. The host can either be an internal host or a public domain host like google.com.
  • Choose deployment type – Enterprise or Service Provider. The Service Provider deployment provides multi-tenancy.
  • Determine whether FIPS should be enabled
  • Choose install type:
    • All-in-one with FortiSIEM Manager
    • Cluster with Manager, Supervisor and Workers
    • All-in-one with Supervisor only, or
    • Cluster with Supervisor and Workers
  • Choose the storage type for Supervisor, Worker, and/or Collector
    • Online - There are 4 choices
      • EventDB on local disk
      • EventDB on NFS
      • ClickHouse
      • Elasticsearch
    • Archive – There are 2 choices
      • EventDB on NFS
      • HDFS
  • Determine hardware requirements and choose the Azure instance type accordingly:
Node vCPU RAM Local Disks

Manager

Minimum – 16
Recommended - 32

Minimum

  • 24GB

Recommended

  • 32GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

Supervisor (All in one) Minimum – 12
Recommended - 32

Minimum

  • without UEBA – 24GB
  • with UEBA - 32GB

Recommended

  • without UEBA – 32GB
  • with UEBA - 64GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

Local Event database – based on need

Supervisor (Cluster) Minimum – 12
Recommended - 32

Minimum

  • without UEBA – 24GB
  • with UEBA - 32GB

Recommended

  • without UEBA – 32GB
  • with UEBA - 64GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

Workers Minimum – 8
Recommended - 16

Minimum – 16GB

Recommended – 24GB

OS – 25GB

OPT – 100GB

Collector Minimum – 4
Recommended – 8 ( based on load)

Minimum – 4GB

Recommended – 8GB

OS – 25GB

OPT – 100GB

  • If your Online event database is external (e.g. EventDB on NFS or Elasticsearch), then you must configure external storage before proceeding to FortiSIEM deployment.

    • For NFS deployment, see here.

    • For Elasticsearch deployment, see here.

  • If your Online event database is internal, that is, inside Supervisor or Worker nodes, then you need to determine the size of the disks based on your EPS and event retention needs.

    • For EventDB on local disk, see here.

    • For ClickHouse, see here.

  • For OPT - 100GB, the 100GB disk for /opt will consist of a single disk that will split into 2 partitions, /OPT and swap. The partitions will be created and managed by FortiSIEM when configFSM.sh runs.

All-in-one Installation

This is the simplest installation with a single Virtual Appliance. If storage is external, then you must configure external storage before proceeding with installation.

Find the FortiSIEM Offer in Azure Using the Azure Marketplace

  1. On the Azure portal, search for Marketplace and navigate to Azure Marketplace.

  2. Search for the keyword "fortisiem".

  3. Select the Create drop-down, and choose Fortinet FortiSIEM for Azure.

    At this point, Azure will take you through the steps to create a virtual machine by first taking you to the Create a virtual machine page. Follow the steps in Create a VM Using a FortiSIEM 6.5.1 Azure Marketplace Image to continue.

Create a VM Using a FortiSIEM 6.5.1 Azure Marketplace Image

From the Create a virtual machine page, take the following steps:

  1. From the Resource group drop-down list, select a resource group.

  2. In the Virtual machine name field, enter a name for your virtual machine.

  3. From the Image drop-down list, select the image.


  4. From the Size drop-down list, select a size based on your node type and hardware requirements.

  5. Under Administrator account, select SSH public key for Authentication type.

  6. The Username field is specified as azureuser.

  7. From the Key pair name drop-down list, select your existing key pair. If needed, generate a new key pair, then select it here.

  8. When done with this step for configuration , click Next: Disks >.

  9. On the Create a new disk page, you will need to create disks based on the following table.

    Volume Name Size Disk Name
    Data Disk LUN 0 100GB

    /opt

    For OPT - 100GB, the 100GB disk for /opt will consist of a single disk that will split into 2 partitions, /OPT and swap. The partitions will be created and managed by FortiSIEM when configFSM.sh runs.

    Data Disk LUN 1 60GB for FortiSIEM Supervisor
    or
    200GB for FortiSIEM Manager
    /cmdb
    Data Disk LUN 2 60GB /svn
    Data Disk LUN 3 60GB+ /data (see the following note)

    Note on Data Disk LUN 3:

    • Add the 4th Data Disk only if using EventDB on local storage or ClickHouse. In all other cases, this disk is not required.
    • For EventDB on local disk, choose a disk based on your EPS and event retention policy. See EventDB Sizing Guide for guidance. 60GB is the minimum.
    • For ClickHouse, choose disks based on the number of Tiers and disks on each Tier. These depend on your EPS and event retention policy. See ClickHouse Sizing Guide for guidance. For example, you can choose 1 large disk for Hot Tier. Or you can choose 2 Tiers - Hot Tier comprised of one or more SSD disks and Warm Tier comprised of one or more magnetic hard disks.
    • Choose Standard SSD volume type for all volumes. For the CMDB partition, you can choose to modify your volume type to Premium SSD or Ultra SSD based on your system workload if you see the consistently high IOPS requirement in your deployment.
    1. In the Name field, enter the name of the disk.

    2. In the Source type drop-down list, leave as None (empty disk).

    3. In the Size drop-down list, select Change size, select the Custom disk size (GiB) option, and enter the disk size in the available field.

    4. Click OK.

    5. For each new disk, click Create and attach a new disk and repeat steps a-d until all the necessary disks have been created.

  10. After entering your disk partition values, click Next: Networking >.

  11. From the Networking page (Networking tab), accept the defaults except for NIC network security groups. For production, choose Advanced and configure the required inbound ports and IP addresses (refer to Azure documentation).

  12. Click Next: Management >.

  13. From the Management page (Management tab), accept the defaults provided or change them as needed per the Azure documentation.

  14. Click Next: Monitoring.

  15. From the Monitoring page (Monitoring tab), under Diagnostics, select Enable with managed storage account (recommended).

    Click Next: Advanced >.


  16. Leave Advanced settings alone, and click Next: Tags >.

  17. From the Tags page (Tags tab), add a Name tag and any other tags as needed.

  18. Click Next: Review + create >.

  19. From the Review + create page tab, verify that all the information is correct. Click Create.


  20. If you chose to create a new SSH key, then you will be asked to download the private key and create the resource. Click Download private key and create resource.

  21. Wait for deployment to succeed. Click Go to resource.


  22. Note the Public IP address and copy it to the clipboard.

  23. (Optional) Configure the DNS name according to Azure documentation.

  24. SSH to the FortiSIEM VM with user azureuser (as specified here) and the downloaded SSH key. Run sudo su – to become user root. Run configFSM.sh.

Configure FortiSIEM

Follow these steps to configure FortiSIEM by using a simple GUI.

  1. At the root command prompt, go to /usr/local/bin and enter configFSM.sh, for example:

    # configFSM.sh

  2. In VM console, select 1 Set Timezone and then press Next.

  3. Select your Location, and press Next.

  4. Select your Continent, and press Next.

  5. Select the Country and City for your timezone, and press Next.

  6. If installing a Supervisor, select 1 Supervisor. Press Next.
    If installing a Worker, select 2 Worker, and press Next.
    If installing a Collector, select 3 Collector, and press Next.
    If Installing FortiSIEM Manager, select 4 FortiSIEM Manager, and press Next.
    If Installing FortiSIEM Supervisor Follower, select 5 Supervisor Follower and press Next.
    Note: The appliance type cannot be changed once it is deployed, so ensure you have selected the correct option.

    note icon

    Regardless of whether you select FortiSIEM Manager,Supervisor, Supervisor Follower, Worker, or Collector, you will see the same series of screens with only the header changed to reflect your target installation, unless noted otherwise.

  7. If you want to enable FIPS, then choose 2 install_with_fips. Otherwise, choose 1 install_without_fips. You have the option of enabling FIPS (option 3) or disabling FIPS (option 4) later. Note: After Installation, a 5th option to change your network configuration (5 change_network_config) is available. This allows you to change your network settings and/or host name.


  8. Determine whether your network supports IPv4-only, IPv6-only, or both IPv4 and IPv6 (Dual Stack). Choose 1 for IPv4-only, choose 2 for IPv6-only, or choose 3 for both IPv4 and IPv6.
  9. If you choose 1 (IPv4) or choose 3 (Both IPv4 and IPv6), and press Next, then you will move to step 10. If you choose 2 (IPv6), and press Next, then skip to step 11.

  10. Configure the IPv4 network by entering the following fields. Press Next.

    OptionDescription
    IPv4 AddressThe Manager/Supervisor/Worker/Collector's IPv4 address
    NetmaskThe Manager/Supervisor/Worker/Collector's subnet
    GatewayNetwork gateway address
    DNS1, DNS2Addresses of the DNS servers

  11. If you chose 1 in step 8, then you will need to skip to step 12. If you chose 2 or 3 in step 8, then you will configure the IPv6 network by entering the following fields, then press Next.

    Option Description
    IPv6 Address The Manager/Supervisor/Worker/Collector's IPv6 address
    prefix (Netmask) The Manager/Supervisor/Worker/Collector's IPv6 prefix
    Gateway ipv6 IPv6 Network gateway address
    DNS1 IPv6, DNS2 IPv6 Addresses of the IPv6 DNS server 1 and DNS server2

    Note: If you chose option 3 in step 8 for both IPv4 and IPv6, then even if you configure 2 DNS servers for IPv4 and IPv6, the system will only use the first DNS server from IPv4 and the first DNS server from the IPv6 configuration.

    Note: In many dual stack networks, IPv4 DNS server(s) can resolve names to both IPv4 and IPv6. In such environments, if you do not have an IPv6 DNS server, then you can use public IPv6 DNS servers or use IPv4-mapped IPv6 address.

  12. Configure Hostname for the FortiSIEM Manager/Supervisor/Worker/Collector. Press Next.


    Note: FQDN is no longer needed.

  13. Test network connectivity by entering a host name that can be resolved by your DNS Server (entered in the previous step) and responds to ping. The host can either be an internal host or a public domain host like google.com. In order for the migration to complete, the system still needs https connectivity to FortiSIEM OS update servers – os-pkgs-cdn.fortisiem.fortinet.com and os-pkgs-c8.fortisiem.fortinet.com. Then, click Next.
    Note: By default, “google.com” is shown for the connectivity test, but if configuring IPv6, you must enter an accessible internally approved IPv6 DNS server, for example: “ipv6-dns.fortinet.com"
    Note: When configuring both IPv4 and IPv6, only testing connectivity for the IPv6 DNS is required because the IPV6 takes higher precedence. So update the host field with an approved IPv6 DNS server.

  14. The final configuration confirmation is displayed. Verify that the parameters are correct. If they are not, then press Back to return to previous dialog boxes to correct any errors. If everything is OK, then press Run.

    The options are described in the following table.

    OptionDescription
    -rThe FortiSIEM component being configured
    -zThe time zone being configured
    -iIPv4-formatted address
    -mAddress of the subnet mask
    -gAddress of the gateway server used
    --hostHost name
    -fFQDN address: fully-qualified domain name
    -tThe IP type. The values can be either 4 (for ipv4) or 6 (for v6) or 64 (for both IPv4 and IPv6).

    --dns1, --dns2

    Addresses of the DNS server 1 and DNS server 2.

    --i6

    IPv6-formatted address

    --m6

    IPv6 prefix

    --g6

    IPv6 gateway

    -o

    Installation option (install_without_fips, install_with_fips, enable_fips, disable_fips, change_network_config*)
    *Option only available after installation.

    -zTime zone. Possible values are US/Pacific, Asia/Shanghai, Europe/London, or Africa/Tunis

    --testpinghost

    The URL used to test connectivity

  15. It will take some time for this process to finish. When it is done, proceed to Upload the FortiSIEM License. If the VM fails, you can inspect the ansible.log file located at /usr/local/fresh-install/logs to try and identify the problem.

Upload the FortiSIEM License

note icon

Before proceeding, make sure that you have obtained valid FortiSIEM license from Forticare. For more information, see the Licensing Guide.

You will now be asked to input a license.

  1. Open a Web browser and log in to the FortiSIEM UI. Use link https://<supervisor-ip> to login. Please note that if you are logging into FortiSIEM with an IPv6 address, you should input https://[IPv6 address] on the browser tab.
  2. The License Upload dialog box will open.

  3. Click Browse and upload the license file.

    Make sure that the Hardware ID shown in the License Upload page matches the license.

  4. For User ID and Password, choose any Full Admin credentials.

    For the first time installation, enter admin as the user and admin*1 as the password. You will then be asked to create a new password for GUI access.

  5. For Supervisor, Worker, or Collector, choose License type as Enterprise or Service Provider. The following option will be available for first time installations. Once the database is configured, this option will not be available.
    For FortiSIEM Manager, License Type is not an available option, and will not appear. At this point, FortiSIEM Manager installation is complete. You will not be taken the Event Database Storage page, so you can skip Configure an Event Database.
    Note: The FortiSIEM Manager license allows a certain number of instances that can be registered to FortiSIEM Manager.
  6. Proceed to Configure an Event Database.

Configure an Event Database

Choose the event database.

If the Event Database is one of the following options, additional disk configuration is required.

Final Check

FortiSIEM installation is complete. If the installation is successful, the VM will reboot automatically. Otherwise, the VM will stop at the failed task.

You can inspect the ansible.log file located at /usr/local/fresh-install/logs if you encounter any issues during FortiSIEM installation.

After installation completes, ensure that the phMonitor is up and running, for example:

# phstatus

For the Supervisor, Supervisor Follower, Worker and Collector, the response should be similar to the following.



For FortiSIEM Manager, the response should look similar to the following.

Cluster Installation

For larger installations, you can choose Worker nodes, Collector nodes, and external storage (NFS, ClickHouse, or Elasticsearch).

Install Supervisor

Follow the steps in All-in-one Installation, except with the following differences.

  1. Event Database choices are EventDB on NFS, ClickHouse, or Elasticsearch.

  2. If you choose EventDB on NFS

    1. Disk 4 is not required (From Create a VM Using a FortiSIEM 6.5.1 Azure Marketplace Image Step 8).

    2. You need to configure NFS after license upload.



  3. If you choose ClickHouse

    1. You need to create disks during Create a VM Using a FortiSIEM 6.5.1 Azure Marketplace Image Step 8 based on the role of the Supervisor node in the ClickHouse cluster. See the ClickHouse Sizing Guide for details.

    2. You need to configure disks after license upload.

  4. If you choose Elasticsearch, define Elasticsearch endpoints after license upload. See the Elasticsearch Sizing Guide for details.

Install Workers

Once the Supervisor is installed, take the same steps in All-in-one Installation to install a Worker with the following differences.

  1. Choose appropriate CPU and memory for the Worker nodes based on Sizing guide.

  2. Two hard disks for Operating Systems and FortiSIEM Application:

    • OS – 25GB

    • OPT – 100GB

      For OPT - 100GB, the 100GB disk for /opt will consist of a single disk that will split into 2 partitions, /OPT and swap. The partitions will be created and managed by FortiSIEM when configFSM.sh runs.

  3. If you are running ClickHouse, then create additional data disks based on the role of the Worker in ClickHouse topology. If it is a Keeper node, then a smaller disk is needed. If it is a data node, then a bigger disk is needed based on your EPS and retention policy. See ClickHouse Sizing Guide for details.

Sizing Guide References:

Register Workers

Once the Worker is up and running, add the Worker to the Supervisor node.

  1. Go to ADMIN > License > Nodes.
  2. Select Worker from the Mode drop-down list and enter the following information:

    1. In the Host Name field, enter the Worker's host name.

    2. In the IP Address field, enter the Worker's IP address.

    3. If you are running ClickHouse, then select the number for Storage Tiers from the Storage Tiers drop-down list, and input disk paths for disks in each Tier in the Disk Path fields.

    4. Click Test.

    5. If the test succeeds, then click Save.

  3. See ADMIN > Health > Cloud Health to ensure that the Workers are up, healthy, and properly added to the system.

Create ClickHouse Topology (Optional)

If you are running ClickHouse, you need to configure ClickHouse topology by specifying which nodes belong to ClickHouse Keeper and Data Clusters. Follow the steps in Configuring ClickHouse Topology.

Install Collectors

Once Supervisor and Workers are installed, follow the same steps in All-in-one Install to install a Collector except when adding disks, you need to only add a data disk for OPT. The recommended settings for Collector node are:

  • CPU = 4
  • Memory = 8GB
  • Two hard disks:
    • OS – 25GB
    • OPT – 100GB
      For OPT - 100GB, the 100GB disk for /opt will consist of a single disk that will split into 2 partitions, /OPT and swap. The partitions will be created and managed by FortiSIEM when configFSM.sh runs.

Register Collectors

Collectors can be deployed in Enterprise or Service Provider environments.

Enterprise Deployments

For Enterprise deployments, follow these steps.

  1. Log in to Supervisor with 'Admin' privileges.
  2. Go to ADMIN > Settings > System > Cluster Config.
    1. Enter the IP of the Worker node in the Event Upload Workers column. If a Supervisor node is only used, then enter the IP of the Supervisor node. Multiple IP addresses can be entered on separate lines. In this case, the Collectors will load balance the upload of events to the listed Event Workers.
      Note: Rather than using IP addresses, a DNS name is recommended. The reasoning is, should the IP addressing change, it becomes a matter of updating the DNS rather than modifying the Event Worker IP addresses in FortiSIEM.
    2. Click Save.
    3. In the Supervisors column, enter the IP of the Supervisor node and click Save.
  3. Go to ADMIN > Setup > Collectors and add a Collector by entering:
    1. Name – Collector Name
    2. Guaranteed EPS – this is the EPS that Collector will always be able to send. It could send more if there is excess EPS available.
    3. Start Time and End Time – set to Unlimited.
  4. SSH to the Collector and run following script to register Collectors:

    phProvisionCollector --add <user> '<password>' <Super IP or Host> <Organization> <CollectorName>

    The password should be enclosed in single quotes to ensure that any non-alphanumeric characters are escaped.

    1. Set user and password using the admin user name and password for the Supervisor.
    2. Set Super IP or Host as the Supervisor's IP address.
    3. Set Organization. For Enterprise deployments, the default name is Super.
    4. Set CollectorName from Step 2a.

      The Collector will reboot during the Registration.

  5. Go to ADMIN > Health > Collector Health for the status.

Service Provider Deployments

For Service Provider deployments, follow these steps.

  1. Log in to Supervisor with 'Admin' privileges.
  2. Go to ADMIN > Settings > System > Event Worker.
    1. Enter the IP of the Worker node. If a Supervisor node is only used, then enter the IP of the Supervisor node. Multiple IP addresses can be entered on separate lines. In this case, the Collectors will load balance the upload of events to the listed Event Workers.
      Note: Rather than using IP addresses, a DNS name is recommended. The reasoning is, should the IP addressing change, it becomes a matter of updating the DNS rather than modifying the Event Worker IP addresses in FortiSIEM.
    2. Click OK.
    3. In the Supervisors column, enter the IP of the Supervisor node and click Save.

  3. Go to ADMIN > Setup > Organizations and click New to add an Organization.

  4. Enter the Organization Name, Admin User, Admin Password, and Admin Email.
  5. Under Collectors, click New.
  6. Enter the Collector Name, Guaranteed EPS, Start Time, and End Time.

    The last two values could be set as Unlimited. Guaranteed EPS is the EPS that the Collector will always be able to send. It could send more if there is excess EPS available.

  7. SSH to the Collector and run following script to register Collectors:

    phProvisionCollector --add <user> '<password>' <Super IP or Host> <Organization> <CollectorName>

    The password should be enclosed in single quotes to ensure that any non-alphanumeric characters are escaped.

    1. Set user and password using the admin user name and password for the Organization that the Collector is going to be registered to.
    2. Set Super IP or Host as the Supervisor's IP address.
    3. Set Organization as the name of an organization created on the Supervisor.
    4. Set CollectorName from Step 6.

      The Collector will reboot during the Registration.

  8. Go to ADMIN > Health > Collector Health and check the status.

Install Manager

Starting with release 6.5.0, you can install FortiSIEM Manager to monitor and manage multiple FortiSIEM instances. An instance includes a Supervisor and optionally, Workers and Collectors. The FortiSIEM Manager needs to be installed on a separate Virtual Machine and requires a separate license. FortiSIEM Supervisors must be on 6.5.0 or later versions.

Follow the steps in All-in-one Install to install Manager. After any Supervisor, Workers, and Collectors are installed, you add the Supervisor instance to Manager, then Register the instance to Manager. See Register Instances to Manager.

Register Instances to Manager

To register your Supervisor instance with Manager, you will need to do two things in the following order.

Note that Communication between FortiSIEM Manager and instances is via REST APIs over HTTP(S).

Adding Instance to Manager

You can add an instance to Manager by taking the following steps.
Note: Make sure to record the FortiSIEM Instance Name, Admin User and Admin Password, as this is needed when you register your instance.

  1. Login to FortiSIEM Manager.

  2. Navigate to ADMIN > Setup.

  3. Click New.

  4. In the FortiSIEM Instance field, enter the name of the Supervisor instance you wish to add.

  5. In the Admin User field, enter the Account name you wish to use to access Manager.

  6. In the Admin Password field, enter the Password that will be associated with the Admin User account.

  7. In the Confirm Admin Password field, re-enter the Password.

  8. (Optional) In the Description field, enter any information you wish to provide about the instance.

  9. Click Save.

  10. Repeat steps 1-9 to add any additional instances to Manager.
    Now, follow the instructions in Register the Instance Itself to Manager for each instance.

Register the Instance Itself to Manager

To register your instance with Manager, take the following steps.

  1. From your FortiSIEM Supervisor/Instance, navigate to ADMIN > Setup > FortiSIEM Manager, and take the following steps.

    1. In the FortiSIEM Manager FQDN/IP field, enter the FortiSIEM Manager Fully Qualified Domain Name (FQDN) or IP address.

    2. If the Supervisor is under a Supervisor Cluster environment, in the FortiSIEM super cluster FQDN/IP field, enter the Supervisor Cluster Fully Qualified Domain Name (FQDN) or IP address.

    3. In the FortiSIEM Instance Name field, enter the instance name used when adding the instance to Manager.

    4. In the Account field, enter the Admin User name used when adding the instance to Manager.

    5. In the Password field, enter your password to be associated with the Admin User name.

    6. In the Confirm Password field, re-enter your password.

    7. Click Test to verify the configuration.

    8. Click Register.
      A dialog box displaying "Registered successfully" should appear if everything is valid.

    9. Login to Manager, and navigate to any one of the following pages to verify registration.

      • ADMIN > Setup and check that the box is marked in the Registered column for your instance.

      • ADMIN > Health, look for your instance under FortiSIEM Instances.

      • ADMIN > License, look for your instance under FortiSIEM Instances.

Install Log

The install ansible log file is located here: /usr/local/fresh-install/logs/ansible.log.

Errors can be found at the end of the file.