📙 You will learn

By default, ThreadFix installs with a database deployed inside a container with the appropriate values already set. The following instructions cover installation of ThreadFix with an external database or other advanced database configurations.

Prerequisites

Audience: IT Professional
Difficulty: Intermediate
Time needed: Approximately 25 minutes
Tools required: MySQL cli or Kubernetes cluster with MySQL container

Requirements:

MySQL server running MySQL 5.7
FQDN or IP for the MySQL server
Account with Administrative access to MySQL
Account with permissions to modify MySQL configuration

Helm installations are configured with yaml files that override default properties. The following examples would need to be invoked with the command -f .yaml appended to the helm installation command. For example, if the yaml file is namedappsec-db.yaml, invoke with ‘helm install tf denimgroup/threadfix -f appsec-db.yaml.

Infrastructure Database only supports MySQL, with the MySQL requirements being the same as AppSec’s.

Configuring External AppSec Database

The following properties must be set for the database to function correctly depending on the database size:

Small Databases

innodb_buffer_pool_size=12G
max_allowed_packet=1G
lower_case_table_names=1

## Pre 3.1.0 configs ## 
max_allowed_packet=256MB
 
#tmp_table_size=6GB
#max_heap_table_size=6GB

Changes to prior recommendations

Lowers max_allowed_packet
Disables/removes the following configs by default. Please note that this needs to be left configured or adjusted (most likely to lower values) for very large CSV Vulnerability Exports

#tmp_table_size=6G
#max_heap_table_size=6G

Medium & Large Databases

The following sample configurations have been tested against a MySQL server hosted on a t3a.2xlarge EC2 instance with 8 vCPU and 32.0 GB RAM.

Please consult ThreadFix Support or a DBA to help configure the database to ensure stability and performance.

## new configs recommended as of release 3.1.0 ##

# The buffer pools size should be 50-70% of overall ram 
innodb_buffer_pool_size=16GB
innodb_buffer_pool_instances=16
lower_case_table_names=1


innodb_log_file_size=1GB
innodb_log_buffer_size = 256M
innodb_io_capacity=1000

join_buffer_size=256K
innodb_read_io_threads=10
innodb_write_io_threads=14 

## Pre 3.1.0 configs ## 
max_allowed_packet=256MB
 
#tmp_table_size=6GB
#max_heap_table_size=6GB

Consult vendors guides for how to properly set these values:

Log into MySQL using the MySQL CLI
1. If a local MySQL CLI is installed, it may be run directly (replace values in angle brackets, <> with their appropriate value).
```
mysql -u<user> -h<hostname> -p
```
2. If a local MySQL CLI is not installed, the ThreadFix kubernetes cluster may be leveraged to run one:
  kubectl run -it --restart=Never --rm --image=mysql:5.7 setup-db -- /bin/bash
  When a bash prompt appear, run the MySQL CLI (replace values in angle brackets, <> with their appropriate value) mysql -u<user> -h<hostname> -p.
Validate that the lower_case_table_names parameter is correctly set.
```
SHOW VARIABLES LIKE 'lower_case_%';
```
The following output should appear:
```
+------------------------+-------+
| Variable_name          | Value |
+------------------------+-------+
| lower_case_file_system | OFF   |
| lower_case_table_names | 1     |
+------------------------+-------+
```
Warning: If the above parameter is not set, the ThreadFix installation will fail. Attempting to install ThreadFix without this variable will cause issues with the installation that will be difficult to reverse.

Create the ThreadFix database.

CREATE DATABASE IF NOT EXISTS `threadfix` CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;

Create the ThreadFix user (replace values in angle brackets, <> with appropriate values).
```
CREATE USER 'ThreadFix'@'%' IDENTIFIED BY '<password>';
```

Grant access to the ThreadFix user.

GRANT ALL ON threadfix.* TO 'ThreadFix'@'%';

Exit the CLI with CTRL-C.
Validate the user login functions (replace values in angle brackets, <> with appropriate values).
```
mysql -u ThreadFix -h <hostname> -p
```

Validate access to the database.

SHOW GRANTS;

The output should show the following:

+--------------------------------------------------------+
| Grants for ThreadFix@%                                 |
+--------------------------------------------------------+
| GRANT ALL PRIVILEGES ON threadfix.* TO 'ThreadFix'@'%' |
+--------------------------------------------------------+

Create External Database Helm Values

To review the pre-requisites for hosting an SQL Server ThreadFix database externally, please refer to the MySQL database setup guides (recommended) or the Windows SQL Server Configuration guide (supported).

Create two files, username.txt and password.txt, containing the username and password credentials respectively for the external database.
- Warning: The external database must already contain the database threadfix, and the username and password configured above must be granted all permissions on that database. For external MySQL instances, the instance must be run with the configuration lower_case_table_names=1.
- Warning: Many text editing tools insert a trailing newline character, \n, to text files by default. If the text editor being used has this property, consult the documentation on how to disable this functionality.
Validate no newline characters have been added to the username and password files. The following should output 0 for both files.
```
wc -l username.txt password.txt
```

Create a kubernetes secret for the external database.

kubectl create secret generic db-user-pass --from-file=username=./username.txt --from-file=password=./password.txt

Remove the previously created files.
```
rm username.txt
rm password.txt
```
Set the FQDN or IP of the database (replace <hostname> with the FQDN or IP of the database).
```
DB_HOSTNAME=<hostname>
```
Set the name of the database to be used (replace <db-name> with the appropriate value default threadfix).
```
DB_NAME=<db-name>
```
Create myValues folder (if it does not exist).
```
mkdir -p myValues
```

Create appsec-db.yaml.

echo "appsec:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME
auth:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME
## 3.1 only
appsec:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME
auth:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME
appsecdata:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME
appsecimporter:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME
appsecvip:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME
queue:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME
jobcoordinator:
  db:
    existingSecret: db-user-pass
    hostnameOverride: $DB_HOSTNAME
    database: $DB_NAME" > myValues/appsec-db.yaml

Complete any other tasks from the Installation Checklist , then Install with Helm.

MySQL - AppSec Only