Upgrade a Splunk SOAR (On-premises) cluster

Perform the following tasks to upgrade your unprivileged cluster.

If you have already downloaded and extracted the installer package to migrate your privileged instance to unprivileged, you can move straight to step 10 and run the install script.

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

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

   reboot

4. 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.
5. 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.
6. 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

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 is running.

   <$PHANTOM_HOME>/bin start_phantom.sh

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

   cd <$PHANTOM_HOME>/splunk-soar

10. With a text editor, update <$PHANTOM_HOME>/splunk-soar/install/install_common.py.
    On or around line 208, modify the GLUSTER_RPM_SOURCE_BASE_URL_EL8 declaration. Change the word "mirror" in the URL to the word "vault."
    GLUSTER_RPM_SOURCE_BASE_URL_EL8 = ("https://vault.centos.org/centos/8-stream/storage/x86_64/gluster-9/Packages/")

    The mirror for GlusterFS packages has moved, changing the URL Splunk SOAR (On-premises) uses download those packages. You will need to update the file install_common.py before you can build or upgrade a clustered deployment, or use a GlusterFS external fileshare.

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.

    If you are converting a privileged cluster to an unprivileged one, you will need to configure your load balancer to listen for your custom HTTPS port. If you did not specify a port during the migration, the port 8443 is set for you. See Manually converting a privileged deployment to an unprivileged deployment for more information.

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

    rm -rf <$PHANTOM_HOME>/splunk-soar