Upgrade a Splunk Phantom cluster

It is now possible to upgrade directly to later releases of Splunk SOAR (On-premises) from Splunk Phantom 4.10.7.

Privileged deployments upgrade directly to Splunk SOAR (On-premises) release 5.3.6, convert to unprivileged, then immediately upgrade to Splunk SOAR (On-premises) release 6.1.1.

Unprivileged deployments upgrade directly to Splunk SOAR (On-premises) release 6.1.1

See Splunk Phantom upgrade overview and prerequisites for more information.

Perform the following tasks to upgrade your Splunk Phantom cluster. This section applies to privileged clusters running on local hardware, or privileged clusters running in Amazon Web Services.

1. Read Splunk Phantom upgrade overview and prerequisites.
2. Prepare each node for upgrade:
   1. On each cluster node, update the operating system and installed packages: See Prepare your Splunk Phantom deployment for upgrade.
   2. On each cluster node, install the Splunk Phantom source repositories and signing keys. See Splunk Phantom repositories and signing keys packages.
3. On each node, log in to the operating system as either the root user or a user with sudo privileges and install the Splunk Phantom repositories and signing keys packages.
4. On each node, one node at a time, Upgrade the cluster node.
5. If the upgrade script produced the following message:

   To improve database performance, after completing the upgrade, run: su - postgres -c '/usr/pgsql-11/bin/vacuumdb -h /tmp --all --analyze-in-stages'

   Then run the command:

   su - postgres -c '/usr/pgsql-11/bin/vacuumdb -h /tmp --all --analyze-in-stages'

6. Once all cluster nodes have been upgraded, reindex playbook data. From Main Menu > Administration > Administration Settings > Search Settings, select "playbooks from the drop-down menu, then click the Reindex Search Data button.

Upgrade the cluster node

Do not attempt to upgrade all the nodes at the same time. Upgrade a single node and bring it back online before proceeding to the next cluster node.

When you have upgraded N+1 nodes, where N is equal to half of the number of nodes in your cluster, database migrations will be applied. This can take a significant amount of time, depending on the amount of data in your database and the version of Splunk Phantom from which you're upgrading.

1. Log in to the operating system as either the root user or a user with sudo privileges.
2. Run the upgrade script. You will be prompted during this script for your Splunk Phantom Community portal login.
   For example, as the root user:

   /opt/phantom/bin/phantom_setup.sh upgrade --without-apps

   If you want to upgrade all of your installed apps during the upgrade use:

   /opt/phantom/bin/phantom_setup.sh upgrade

   Because upgraded apps may require changes to their asset configuration, apps should be individually evaluated and upgraded using Main Menu > Apps, then clicking the APP UPDATES button.