Upgrade a single privileged instance

When you upgrade your Splunk SOAR (On-premises) deployment to release 5.4.0 your privileged deployment will be automatically converted to an unprivileged one. For more information on this conversion, see Convert a privileged deployment to an unprivileged deployment.

If your Splunk SOAR (On-premises) deployment cannot use firewalld, see If you cannot use firewalld in your deployment to manually convert your release 5.3.5 deployment to an unprivileged deployment. Then, use the installer and the instructions in Upgrade a single unprivileged Splunk SOAR (On-premises) instance to upgrade your 5.3.5 instance to release 5.4.0.

Follow these steps to upgrade your instance.

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 upgrade overview and prerequisites.
2. Make sure that the root user is in the sudoers group.

   sudo --validate

3. (Conditional) If the root user is not in the sudoers group, add them to the sudoers group, either by editing /etc/sudoers or by using a command such as usermod

   usermod -aG sudo root

4. Restart the operating system if you did not recently restart it as part of the preparations in Step 1.
   This step is required to ensure that the upgrade completes successfully and efficiently.
   As the root user:

   reboot

5. After the system restarts, log in to the operating system as either the root user or a user with sudo privileges.
6. 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.
7. 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

8. 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.
9. Make sure that that your current installation of is running.

   <$PHANTOM_HOME>/bin start_phantom.sh

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

    cd <$PHANTOM_HOME>/splunk-soar

11. 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.

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

    rm -rf <$PHANTOM_HOME>/splunk-soar