Upgrade an unprivileged Splunk SOAR (On-premises) cluster

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

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 SOAR (On-premises) upgrade overview and prerequisites for more information.

Perform the following tasks to upgrade your unprivileged Splunk SOAR (On-premises) cluster.

For each SOAR node, follow the upgrade instructions, one node at a time:

The same TAR file is used for install and upgrade processes. The file detects the presence of SOAR and installs or upgrades accordingly.

1. Read Splunk SOAR (On-premises) upgrade overview and prerequisites.
2. Restart the operating system if you did not recently restart it as part of the prerequisites in Step 1.
   This step is required to ensure that the upgrade completes successfully and efficiently.
   As the root user:

   reboot

3. After the system restarts, log in to the operating system as the user that owns Splunk SOAR (On-premises). Do not perform the upgrade as the root user.
4. Download the unprivileged installer from the Splunk SOAR site. The unprivileged installer prepackages its dependencies and can be installed on systems that cannot reach out to the internet.
   The unprivileged installer is named in the format splunk_soar-unpriv-<major>.<minor>.<patch>.<build>-<commit_short_sha>-<os>-x86_64.tgz.
5. Conditional: If you have previously upgraded this instance of Splunk SOAR (On-premises), you may still have a directory at <$PHANTOM_HOME>/splunk-soar. If that is true, remove that directory.

   rm -rf <$PHANTOM_HOME>/splunk-soar

6. Conditional: If this instance of Splunk SOAR (On-premises) is installed on RHEL 8.x, and you have previously tried to upgrade it with the installer for RHEL 7.x then the directory <$PHANTOM_HOME>/usr/lib64 must be removed.

   rm -fr <$PHANTOM_HOME>/usr/lib64

   Do not do this step if you are installing Splunk SOAR (On-premises) on RHEL 7.x

7. Extract the TAR file you downloaded into the Splunk SOAR (On-premises) installation directory.

   tar -xvf <installer>.tgz -C <$PHANTOM_HOME>

   This creates a new directory in the Splunk SOAR (On-premises) home directory, <$PHANTOM_HOME>/splunk-soar.
8. Make sure that that your current installation of Splunk SOAR (On-premises) is running.

   <$PHANTOM_HOME>/bin start_phantom.sh

9. Change directory to the <$PHANTOM_HOME>/splunk-soar directory.

   cd <$PHANTOM_HOME>/splunk-soar

10. The installer package you extracted creates a file called soar-install in the <$PHANTOM_HOME>/splunk-soar directory. Run that script:

    ./soar-install --upgrade --with-apps

    You can see the full list of arguments for the soar-install script by using the --help option.

11. After the upgrade is complete, remove installation package by deleting the <$PHANTOM_HOME>/splunk-soar directory.

    rm -rf <$PHANTOM_HOME>/splunk-soar