Splunk® SOAR (On-premises)

Install and Upgrade Splunk SOAR (On-premises)

The visual editor for classic playbooks was removed from Splunk SOAR in release 6.4.0. Convert your classic playbooks to modern mode. Your classic playbooks will continue to run and you can view and edit them in the SOAR Python code editor.
For details, see:

Migrate a Splunk SOAR (On-premises) install from RHEL 8 to RHEL 9

Support for Red Hat Enterprise Linux 9 (RHEL) was added with the release of version 6.4.0. This topic provides a high-level overview of the process for migrating your host's operating system to RHEL 9.

This article focuses on the current Splunk SOAR (On-premises) release. You can upgrade to any Splunk SOAR (On-premises) release 6.4.0 or higher.

Operating system upgrade or migration checklist

Use this table as a guide to migrating or upgrading your Splunk SOAR (On-premises) host or cluster node hosts to Red Hat Enterprise Linux 9.

Step Description
1 Make a full backup of your existing Splunk SOAR (On-premises) host or cluster. See Splunk SOAR (On-premises) backup and restore overview.
2 Download the Splunk SOAR (On-premises) release 6.4.0 installation TAR file for your current operating system. You will need to copy the installation TAR file to each host you intend to upgrade. See Get Splunk SOAR (On-premises).
3 Determine your migration or upgrade path.
  1. Conditional: If your Splunk SOAR (On-premises) hosts are on CentOS 7 or Red Hat Enterprise Linux 7, you must first migrate to Red Hat Enterprise 8. See Migrate a Splunk SOAR (On-premises) install from RHEL 7 or CentOS 7 to RHEL 8
  2. Conditional: If your Splunk SOAR (On-premises) hosts are already on Red Hat Enterprise Linux 8, or you have just upgraded the hosts to RHEL 8, upgrade Splunk SOAR (On-premises) to release 6.4.0. See Splunk SOAR (On-premises) upgrade overview and prerequisites.
  3. Upgrade your Splunk SOAR (On-premises) hosts to Red Hat Enterprise Linux 9. See the article Upgrading from RHEL 8 to RHEL 9 on the Red Hat site.
4 Once your Splunk SOAR (On-premises) hosts have been upgraded to Red Hat Enterprise Linux 9, upgrade Splunk SOAR (On-premises) packages for the new operating system.
  1. Download the correct installation TAR file for your new operating system. See Get Splunk SOAR (On-premises).
  2. Update Splunk SOAR (On-premises) with the correct packages and updates for the new operating system. See Upgrade Splunk SOAR (On-premises) packages for your new operating system.
5 If you are upgrading a Splunk SOAR (On-premises) cluster, see Upgrade the operating system for Splunk SOAR (On-premises) clusters.

Upgrade Splunk SOAR (On-premises) packages for your new operating system

Once you have upgraded the operating system on your deployment in place, you will need to run the upgrade for to apply operating system dependent updates.

  1. Download the Splunk SOAR (On-premises) installation TAR file for your new operating system. See Get Splunk SOAR (On-premises).
  2. Extract the TAR file you downloaded into the Splunk SOAR (On-premises) installation directory.
    tar -xvf <installer>.tgz -C <$PHANTOM_HOME>
    Extracting the TAR file this way creates a new directory in the Splunk SOAR (On-premises) home directory, <$PHANTOM_HOME>/splunk-soar.
  3. Re-run the install script using the --dist-upgrade option.
    <$PHANTOM_HOME>/splunk-soar/soar-install --dist-upgrade

Before you can use the --dist-upgrade option, you must already have upgraded Splunk SOAR (On-premises) to release 6.4.0.

Upgrade the operating system for Splunk SOAR (On-premises) clusters

There are two methods you can use to upgrade the operating system on a Splunk SOAR (On-premises) cluster:

  • Upgrade the operating system for each cluster node.
  • Create new Splunk SOAR (On-premises) release 6.4.0 nodes for your cluster on the desired operating system, add them to your cluster, then decommission nodes running the previous operating system.

Upgrade the operating system for each Splunk SOAR (On-premises) cluster node

This method converts and upgrades the operating system on your deployment for clusters in place. Before you begin, ensure that all cluster nodes are using a release 6.4.0.

You can upgrade cluster nodes in a rolling fashion by doing the following steps:

  1. Upgrade the cluster nodes, one at a time to release 6.4.0. See Splunk SOAR (On-premises) upgrade overview and prerequisites.
  2. On each cluster node, one at a time, upgrade the installed operating system from RHEL 8 to RHEL 9, following Red Hat's instructions for upgrading RHEL 8 to RHEL 9. See Upgrading from RHEL 8 to RHEL 9 on the Red Hat site.
  3. Download the Splunk SOAR (On-premises) installation TAR file for your new operating system, and copy it to each cluster node. See Get Splunk SOAR (On-premises).
  4. On each cluster node, one at a time, extract the TAR file you downloaded into the Splunk SOAR (On-premises) installation directory.
    tar -xvf <installer>.tgz -C <$PHANTOM_HOME>
    Extracting the TAR file this way creates a new directory in the Splunk SOAR (On-premises) home directory, <$PHANTOM_HOME>/splunk-soar.
  5. On each cluster node, one at time, re-run the install script using the --dist-upgrade option.
    <$PHANTOM_HOME>/splunk-soar/soar-install --dist-upgrade

Before you can use the --dist-upgrade option, you must already have upgraded Splunk SOAR (On-premises) to release 6.4.0.

Upgrade the Splunk SOAR (On-premises) cluster by adding and removing cluster nodes

If you prefer, you can upgrade your cluster by building new cluster nodes, adding them to your cluster, then decommissioning cluster nodes running earlier versions of Splunk SOAR (On-premises). For information on adding or removing cluster nodes from your Splunk SOAR (On-premises) cluster, see Add or remove a cluster node from Splunk SOAR (On-premises).

Last modified on 05 March, 2025
Migrate a Splunk SOAR (On-premises) install from RHEL 7 or CentOS 7 to RHEL 8   Migrate a Splunk SOAR (On-premises) install from CentOS 7 to Oracle Linux 8

This documentation applies to the following versions of Splunk® SOAR (On-premises): 6.4.0


Please expect delayed responses to documentation feedback while the team migrates content to a new system. We value your input and thank you for your patience as we work to provide you with an improved content experience!

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