Splunk® Phantom (Legacy)

Install and Upgrade Splunk Phantom

Splunk Phantom 4.10.7 is the final release of Splunk's Security Orchestration, Automation, and Response (SOAR) system to be called Splunk Phantom. All later versions are named Splunk SOAR (On-premises). For more information, see the Splunk SOAR (On-premises) documentation.

Set up an external PostgreSQL server

Splunk Phantom uses a PostgreSQL 11 database. In many installations, the database runs on the same server as Splunk Phantom. It is possible to put the database on its own server. For more information about configuring and operating a PostgreSQL database, consult the PostgreSQL website and their documentation.

Install and configure PostgreSQL

If you run the PostgreSQL database on its own server, install and configure PostgreSQL before installing Splunk Phantom.

These instructions are based on CentOS 7 or Red Hat Enterprise Linux 7. If you choose to to install PostgreSQL on another operating system, consult the documentation on the PostgreSQL website.

  1. Install one of the operating systems supported by PostgreSQL 11. PostgreSQL 11.11 is recommended, but you may use any release of PostgreSQL 11.x. Configure the operating system according to your organization's requirements. See Supported Platforms on PostgreSQL.org.
  2. Update the kernel semaphore parameters and refresh the system configuration.
    echo "kernel.sem=250 32000 32 5000" >> /etc/sysctl.conf 
    sysctl --system
  3. Configure your firewall to allow access. For a complete list of ports, see Splunk Phantom required ports.
  4. Add any additional yum repositories that you need. Use the tool on the Linux downloads (Red Hat family) page to identify the correct repository for your architecture and operating system combination.
    yum install <URL>
  5. Install the PostgreSQL server.
    yum install postgresql11-server-11.11
  6. Initialize the PostgreSQL database.
    /usr/pgsql-11/bin/postgresql-11-setup initdb
  7. Set PostgreSQL to start when the system starts.
    systemctl enable postgresql-11
  8. Start the PostgreSQL database.
    systemctl start postgresql-11
  9. Change to the postgres user.
    su - postgres
  10. Change to the PostgreSQL data directory.
    cd /var/lib/pgsql/11
  11. Generate the SSL certificate PostgreSQL uses.
    openssl req -new -x509 -days 3650 -nodes -text -out server.crt -keyout server.key -subj "/CN=postgres.cluster1"

    You can use an SSL certificate purchased from a Certificate Authority instead of generating a self-signed certificate.

  12. Set the permissions on the server.key file.
    chmod og-rwx server.key
  13. Run a PostgreSQL shell as the postgres user.

    You should already be the postgres user.

  14. Set the postgres user password, if it has not already been set.
    ALTER USER postgres PASSWORD '<postgrespassword>';
  15. Create the pgbouncer user.
    CREATE USER pgbouncer PASSWORD '<pgbouncerpassword>';
  16. Set PostgreSQL to use SSL. Provide the keys and cipher level.
    ALTER SYSTEM SET ssl = on; 
    ALTER SYSTEM SET ssl_cert_file = '/var/lib/pgsql/11/server.crt'; 
    ALTER SYSTEM SET ssl_key_file = '/var/lib/pgsql/11/server.key'; 
    ALTER SYSTEM SET ssl_ciphers = 'HIGH:+3DES:!aNULL';
  17. Exit the PostgreSQL shell by typing CTRL+D.
  18. Change back to the root user.
  19. Edit the pg_hba.conf file to enable access to the database. Splunk Phantom must be able to connect as both the postgres and pgbouncer users. In each entry, supply the IP range that will be used by your Splunk Phantom install or cluster.
    # TYPE  DATABASE    USER        ADDRESS         METHOD
    local   all	    all         peer		
    hostssl all         postgres    <IP Range>/<XX> md5
    hostssl phantom     pgbouncer   <IP Range>/<XX> md5
  20. Edit postgresql.conf. Set values for max_connections, work_mem, shared_buffers, and listen_address.
    listen_addresses = '*' # what IP address(es) to listen on;

    Several factors can influence the amount of memory dedicated to the work_mem setting. Larger, high event volume deployments will want significantly more, while smaller, lower volume deployments may use slightly less. The setting above assumes a medium sized deployment with a moderate event volume.

    For listen_address set a value that matches your security requirements. Valid settings are:

    • * for all addresses, 0.0.0. for all IPv4 addresses
    • :: for all IPv6 addresses
    • specific addresses you supply.
  21. Restart the PostgreSQL service.
    systemctl restart postgresql-11

Backup a Splunk Phantom database and restore to an external database

To backup a Splunk Phantom database and restore it on an external database, use the ibackup.pyc tool. See Splunk Phantom backup and restore overview in Administer Splunk Phantom.

Create an external PostgreSQL database in AWS RDS

Some Splunk Phantom deployments, especially those in Amazon Web Services, may want to put the PostgreSQL database on its own host using AWS's Relational Database Service (RDS). These steps can also be used to migrate a standalone Splunk Phantom instance to an instance using a PostgreSQL database hosted in AWS' RDS.

For more information on building a PostgreSQL database host in RDS, see the Amazon Relational Database Service documentation.


Number Task Description
1 Create a PostgreSQL database in AWS. Create the external PostgreSQL database with the Relational Database System
2 Create the pgbouncer user account. Create the pgbouncer user for the RDS
3 Back up the Splunk Phantom instance's PostgreSQL database, then restore it to the AWS RDS instance. Backup a Splunk Phantom database and restore to an external database

Create the external PostgreSQL database with the Relational Database System (RDS)

Splunk Phantom uses a PostgreSQL 11.11 database. In many installations, the database runs on the same server as Splunk Phantom. If you opt to run the PostgreSQL database on its own Amazon Web Services RDS instance, follow the procedures here. These instructions assume you already have an AWS account and VPCs established for your organization's resources.

These instructions use PostgreSQL version 11.11. You may use any PostgreSQL 11.x release. If you do use a different release, you must to use matching parameters for your release where PostgreSQL 11.11 is specified in these instructions.

  1. From your EC2 dashboard, click Services in the menu bar, and under Database choose RDS.
  2. Click Create database.
  3. Select Standard Create.
  4. Under Engine options, select PostgreSQL.
  5. For Version, select 11.11 from the menu.
  6. For Templates, select either Production for production environments or Dev/Test for development/testing or Proof of Value environments.
  7. Under Settings, type a name for your DB instance identifier. Make sure that the name is unique across all DB instances owned by your AWS account.
  8. Under Credential Settings:
    1. Master username: postgres
    2. Make sure the Auto generate a password checkbox is not selected.
    3. Type and confirm the Master password in the fields provided. Record this password. You will need it later.
  9. Under DB instance size, select the radio button that matches your organization's needs.

    Warning: Instances below db.t2.large may deplete their available connections before installation of Splunk Phantom is complete.

  10. Under Storage, select a Storage type based on your organization's needs.
    1. For Allocated storage, set a number of GiB that matches your organization's needs.

      Warning: Splunk Phantom Databases below 500 gigabytes of storage are not supported for production use.

    2. Select the Enable storage autoscaling check box.
    3. Set Maximum storage threshold to 1000 (GiB).
  11. Under Availability & durability, select the Do not create a standby instance radio button.
  12. Under Connectivity, select the same VPC as you used for your Splunk Phantom instance.
  13. Under the Additional connectivity configuration section:
    1. Select the correct Subnet group. The available groups depend on your VPC selection.
    2. Under Publicly accessible, select the No radio button.
    3. Under VPC security group, select Choose existing.
    4. Select the appropriate security group from the menu.
    5. Click the X icon to remove any unwanted security groups that were added by default.
    6. Make sure the Database port is set to 5432.
  14. Under Additional configuration, Database options:
    1. Type phantom for Initial database name.
    2. Make sure the DB parameter group is set to default.postgres11.11.
  15. Under Additional configuration, Backup, leave everything at the defaults.
  16. Click Create Database.

Create the pgbouncer user for the RDS

Splunk Phantom interacts with the PostgreSQL database using the pgbouncer user account. This account needs to be created for the database you built in RDS.

  1. SSH to the operating system of your Splunk Phantom instance.
  2. Elevate to root.
    sudo su -
  3. Create the pgbouncer user.
    psql --host <DNS name for RDS instance> --port 5432 --username postgres --echo-all --dbname phantom --command "CREATE ROLE pgbouncer WITH PASSWORD '<pgbouncer password>' login;"
  4. Make the pgbouncer user a superuser.
    psql --host <DNS name for RDS instance> --port 5432 --username postgres --echo-all --dbname phantom --command "GRANT rds_superuser TO pgbouncer;"

Backup the external PostgreSQL database with the Relational Database System (RDS)

To backup an external PostgreSQL database with the RDS, perform the following steps as the root user or a user with sudo permissions.

You must use identical versions of Splunk Phantom for this procedure. For example, if your PostgreSQL backup is from Splunk Phantom 4.9.39220, you must restore it to use with an instance of Splunk Phantom 4.9.39220.

  1. Backup the database.
    cd <PHANTOM_HOME>/bin
    phenv python backup.pyc --all
  2. Copy the file path that shows the backup file that was created to use in a future step.
    All data backed up to <PHANTOM_HOME>/data/phantom_backups/phantom_backup_2017-07-15-20-47-04.126913.tgz
  3. Edit the /etc/pgbouncer/pgbouncer.ini (privileged deployments) or <PHANTOM_HOME>/etc/pgbouncer/pgbouncer.ini (unprivileged deployments) file as shown in the following code. host is the IP address or DNS name of the database server.
    phantom = user=pgbouncer password=<pgbouncerpassword> host=<pg server>
    postgres = user=postgres password=<postgrespassword> host=<pg server>
    server_tls_sslmode = require

    Amazon Web Services RDS PostgreSQL databases do not need the server_tls_sslmode = require entry.

  4. Stop all Splunk Phantom services.
  5. Reload pgbouncer. For all deployments, use the following command:
    <PHANTOM_HOME>/bin/phsvc restart pgbouncer
  6. Test the connection to the database server.
    Privileged deployments:
    sudo -u postgres psql -h /tmp -p 6432

    Unprivileged deployments:

    <PHANTOM_HOME>/bin/phenv psql  -h /tmp -p 6432 -d postgres

    If connectivity is successful, you will see the following message:

    psql (11.11)
    Type "help" for help.
  7. Initialize the database to use with Splunk Phantom.
    cd <PHANTOM_HOME>/bin
    phenv prepare_db
  8. Start all Splunk Phantom services.
  9. Restore the backup using the file name you copied in step 2.
    cd <PHANTOM_HOME>/bin
    phenv python restore.pyc --file <PHANTOM_HOME>/data/phantom_backups/phantom_backup_2017-07-15-20-47-04.126913.tgz
  10. Connect to the Splunk Phantom server's web user interface.
Last modified on 17 September, 2021
Run make_cluster_node.pyc   Set up external file shares using GlusterFS

This documentation applies to the following versions of Splunk® Phantom (Legacy): 4.10.3, 4.10.4, 4.10.6, 4.10.7

Was this topic useful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters