Splunk® SOAR (On-premises)

Install and Upgrade Splunk SOAR (On-premises)

The classic playbook editor will be deprecated in early 2025. Convert your classic playbooks to modern mode.
After the future removal of the classic playbook editor, your existing classic playbooks will continue to run, However, you will no longer be able to visualize or modify existing classic playbooks.
For details, see:
This documentation does not apply to the most recent version of Splunk® SOAR (On-premises). For documentation on the most recent version, go to the latest release.

Upgrade a single unprivileged instance

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.

Follow these steps to upgrade your unprivileged instance, or to convert and upgrade your existing, privileged instance to an unprivileged instance. Use these steps even if your unprivileged instance has limited access to the internet. The installation TAR file contains everything needed to complete this upgrade.

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. 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 either the root user or a user with sudo privileges.
  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>-el7-x86_64.tgz.
  5. Extract the TGZ file you downloaded into the Splunk SOAR (On-premises) home directory using tar -xvf <installer>.tgz.
  6. Log in as the user who owns the Splunk SOAR (On-premises) upgrade. Do not perform the upgrade as the root user.
  7. Change directory to the <Splunk SOAR (On-premises) home> directory.
  8. The installer package you extracted creates a file called soar-install in the <Splunk SOAR (On-premises) home> directory. Run that script: 
    ./soar-install --splunk-soar-home <$PHANTOM_HOME> --upgrade --with-apps
    1. Conditional: If you extracted the installation TAR file to a different directory than <$PHANTOM_HOME>/splunk-soar, you must supply the path to your Splunk SOAR (On-premises) installation to the installation script. 
      <path/to/extracted/TAR file>/soar-install --splunk-soar-home <path/to/$PHANTOM_HOME> --upgrade --with-apps

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

Last modified on 29 September, 2023
Upgrade a single privileged instance   Upgrade a privileged cluster

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

Acrobat logo Download manual
Acrobat logo Download this page

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