Splunk Phantom upgrade overview and prerequisites

Splunk Phantom requires incremental upgrades from earlier versions.

Starting Splunk Phantom release	Build number	Upgrade to version	Build number
2.1	2.1.486	3.0	3.0.284
3.0	3.0.284	3.5	3.5.210
3.5	3.5.210	4.0	4.0.1068
4.0	4.0.1068	4.1	4.1.94
4.1	4.1.94	4.2	4.2.7532
4.2	4.2.7532	4.5	4.5.15922
4.5	4.5.15922	4.6	4.6.19142
4.6	4.6.19142	4.8 patch 1	4.8.24304
4.8 patch 1	4.8.24304	4.9 Release 5	4.9.39220
4.9 Release 5	4.9.39220	4.10.3	4.10.3.51237
4.10	4.10.0.40961	4.10.3	4.10.3.51237
4.10.1	4.10.1.45070	4.10.3	4.10.3.51237
4.10.2	4.10.2.47587	4.10.3	4.10.3.51237

Do not skip any required versions when upgrading Splunk Phantom. For example, to upgrade Splunk Phantom from version 4.8 to version 4.10.3, you must upgrade to version 4.9 before upgrading to version 4.10.3.

Upgrade checklist

Follow these steps to prepare for and then perform an upgrade of Splunk Phantom.

Stage	Tasks	Description
1	Make a full back up of your Splunk Phantom deployment	Make a full backup of your Splunk Phantom deployment before upgrading. See Backup or restore your Splunk Phantom instance in Administer Splunk Phantom. For single instance deployments running as a virtual machine, you can create a snapshot of the virtual machine instead.
2	Do the prerequisites	See Prerequisites for upgrading Splunk Phantom. Obtain logins Make sure the Splunk Phantom instance or cluster nodes have enough available space. If needed, add a local yum repository or create a satellite server for yum updates.
3	Prepare your Splunk Phantom deployment for upgrade	See Prepare your Splunk Phantom deployment for upgrade. Update the operating system and installed software packages Install the Splunk Phantom repositories and signing keys
4	Upgrade Splunk Phantom	See Upgrade Splunk Phantom

After all the preparation stages are complete, you can upgrade your Splunk Phantom instance or cluster. For clustered deployments, after the preparation stages are complete, upgrading your Splunk Phantom cluster is done in a rolling fashion, one node at a time.

Prerequisites for upgrading Splunk Phantom

You need the following information before beginning your upgrade:

• Logins
  • For privileged deployments, user accounts on the operating system for your Splunk Phantom instance or cluster nodes with sudo or root access on those systems.
  • For unprivileged deployments, you also need the login credentials for the user account that runs Splunk Phantom. For new AMI or OVA versions of Splunk Phantom 4.10, the user account is phantom.
  • Your Splunk Phantom Community portal login.
• If your Splunk Phantom deployment has restricted internet access, you will need a local yum repository or a satellite server from which to get yum packages.
• A minimum of 5GB of space available in the /tmp directory on the Splunk Phantom instance or cluster node.

For deployments with restricted internet access, add local yum repositories for upgrade

If your Splunk Phantom deployment has no access or restricted access to the internet, you must either create a satellite server or local YUM repository for operating system packages and other dependencies. See the Red Hat Knowledgebase article How can we regularly update a disconnected system (A system without internet connection)?

The required upgrade repositories are:

OS version	CentOS	RHEL
7	[base] [updates]	[rhel-7-server-rpms] [rhel-server-rhscl-7-rpms] [rhel-7-server-optional-rpms]

Prepare your Splunk Phantom deployment for upgrade

Before you upgrade Splunk Phantom, you will need to prepare your instance or your cluster nodes by updating the operating system, installed packages, and adding the Splunk Phantom repositories and their signing keys.

Migrate a privileged deployment to an unprivileged deployment

In Splunk Phantom 4.10 and for future releases, the AMI and OVA versions of Splunk Phantom are unprivileged. New AMI and OVA installations run Splunk Phantom as the user account phantom rather than as root.

If your deployment intends to migrate an existing deployment from a privileged to an unprivileged deployment as part of your upgrade to from Splunk Phantom 4.9 to Splunk Phantom version 4.10, you will use the 'Official Unprivileged Tarball to complete your upgrade and conversion. See Upgrade a single unprivileged Splunk Phantom instance or Upgrade an unprivileged Splunk Phantom Cluster.

Update the operating system and installed packages

Follow these steps to update the operating system and otherwise prepare your deployment for the upgrade.

For a clustered deployment of Splunk Phantom, prepare cluster nodes in a rolling fashion, one cluster node at a time.

1. Log in to the Splunk Phantom instance's operating system:
   1. For privileged deployments, log in as the root user or a user with sudo privileges.
   2. For unprivileged deployments, log in as the user account that runs Splunk Phantom.
2. If you use a warm standby or use ibackup.pyc for backups, you must disable those features before proceeding. If you are not using either of those features, you may skip these sub-steps.
   1. On a single instance deployment of Splunk Phantom, disable warm standby. See Upgrade or maintain warm standby instances in Administer Splunk Phantom.
   2. If you are using automation to run ibackup.pyc to make backups, cancel backups that could run during your upgrade window. For example, if you have configured a cron job to run ibackup.pyc, disable that cron job.
   3. Disable WAL archiving for the PostgreSQL database. Set the archive_mode to "off" in the file /opt/phantom/data/db/postgresql.phantom.conf. If your PostgreSQL database is on its own server, you need to disable WAL archiving on that system, not the Splunk Phantom instance.

      sed -i -e 's/archive_mode = on/archive_mode = off/i' /<PHANTOM_HOME>/data/db/postgresql.phantom.conf

   4. Restart PostgreSQL to make the configuration change take effect.

      /<PHANTOM_HOME>/bin/phsvc restart postgresql-11

3. Stop all Splunk Phantom services. For example, as the root user:

   /<PHANTOM_HOME>/bin/stop_phantom.sh

4. Clear the YUM caches. As the root user:

   yum clean all

5. Update the installed software packages, excluding Nginx, and apply operating system patches. As the root user:

   yum update --exclude=nginx

   Systems which cannot access YUM repositories over the internet need a satellite server. See For deployments with restricted internet access, add local yum repositories for upgrade.

   If you are using the EPEL repository some packages may be upgraded to a version higher than supported by Splunk Phantom. In this case, you want to use the Official Offline RPMs instead of using YUM to get the required versions of package dependencies for Splunk Phantom. See For Splunk Phantom deployments without internet access or unprivileged deployments for instructions.

6. If a kernel update was included in your operating system updates, restart the operating system. As the root user:

   reboot

   If you did not need to restart the operating system, restart Splunk Phantom. As the root user:

   /<PHANTOM_HOME>/bin/start_phantom.sh

7. If a system restart was required, after the system restarts, log in to the operating system as either the root user or a user with sudo privileges.
8. The install script requires the ability to create jobs in cron. See System requirements for production use. Check that the cron daemon is running.

   ps -ef | grep crond

   1. If the cron daemon is not running, start it.

      systemctl start crond.service

Install the Splunk Phantom repositories and signing keys

• For privileged deployments with internet access, install the Splunk Phantom repository and signing keys. See Splunk Phantom repositories and signing keys packages.
• For unprivileged deployments, or deployments with limited internet access, the repositories and signing keys are included in the upgrade tar file. See For Splunk Phantom deployments without internet access or unprivileged deployments.

Upgrade Splunk Phantom

When you are ready to upgrade Splunk Phantom, follow one of these sets of instructions, based on the type of your Splunk Phantom deployment.

• Upgrade a single Splunk Phantom instance.
• Upgrade a single Splunk Phantom instance on a system with limited internet access.
• Upgrade a single unprivileged Splunk Phantom instance.
• Upgrade a Splunk Phantom cluster.
• Upgrade an unprivileged Splunk Phantom cluster.