Splunk® User Behavior Analytics

Install and Upgrade Splunk User Behavior Analytics

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF

Upgrade a single node AMI or OVA installation of Splunk UBA

Perform the following steps to upgrade a single node AMI or OVA installation of Splunk UBA.

Upgrading to Splunk UBA version 5.2.0 on an AMI or OVA also requires you upgrade to Ubuntu version 20.04.

Before you begin

Make sure the correct hadoop ports are open. See, Inbound networking port requirements.

Before upgrading Splunk UBA on a single server, confirm you meet the Upgrade Splunk UBA prerequisites

If you have enabled the integration that sends UBA audit data to Splunk Enterprise Security (ES), preserve the associated certificate before upgrading. For more info on sending audit data to ES see, Send Splunk UBA audit events to Splunk ES. Use the following command to export the certificate:

. /opt/caspida/bin/CaspidaCommonEnv.sh
sudo keytool -exportcert -alias "splunk es" -keystore $JAVA_HOME/lib/security/cacerts -rfc -file ~/splunk-es_cacert.pem

Single server upgrade steps

The Splunk UBA AMI and OVA images use Ubuntu as the operating system. Ensure that Splunk UBA is running before you upgrade then perform the following tasks to upgrade Splunk UBA on a single server with Ubuntu operating system.

  1. Stop all the caspida services.
    /opt/caspida/bin/Caspida stop-all
  2. Archive the previous UBA release. Replace <old-uba-version> with your version of UBA:
    sudo mkdir -p /var/vcap/release_archives
    sudo mv /opt/caspida /var/vcap/release_archives/caspida-<old-uba-version>
    sudo mkdir -p /opt/caspida && sudo chown caspida:caspida /opt/caspida
    sudo chown caspida:caspida /var/vcap/release_archives
    sudo chown caspida:caspida /var/vcap/release_archives/caspida-<old-uba-version>
  3. .
  4. Download the latest UBA branch build splunk-uba-software-upgrade-package_520.tgz and untar the UBA bits to /home/caspida directory:
    $ tar xvzf /home/caspida/splunk-uba-software-upgrade-package_520.tgz
  5. Untar the UBA 5.2.0 Platform build inside the /opt/caspida/ folder:
    tar xvzf /home/caspida/Splunk-UBA-Platform-5.2.0-20230202-8254784.tgz -C /opt/caspida
  6. Update the package information.
    sudo apt-get update
  7. Remove the grub-pc package, then reinstall. This is done because there is an existing Ubuntu upgrade bug that is avoided with a clean install of this package.
    1. Remove by purging the grub-pc package:
      sudo apt-get purge grub-pc -y
    2. Reinstall grub-pc package:
      sudo apt-get install grub-pc -y 
    3. When the interactive prompt comes up to choose a disk, select your BOOT disk if known. If BOOT disk is not known, select all disk choices.

      Failure to choose the correct disk will result in it not being able to boot up.

  8. Reboot the system:
    sudo reboot
  9. If you are running Ubuntu 16.04, perform these steps:
    1. Upgrade the OS from Ubuntu 16.04 to Ubuntu 18.04 with the following command:
      sudo /opt/caspida/upgrade/utils/upgrade_ubuntu.sh -t 18.04
    2. After Ubuntu is upgraded, reboot the system:
      sudo reboot
  10. Then upgrade from Ubuntu 18.04 to Ubuntu 20.04 using these steps:
    1. Install the newest available versions of all packages and reboot. Run the following commands:
      sudo apt-get update
      sudo apt-get dist-upgrade
      sudo reboot
    2. Run the following command to upgrade to Ubuntu 20.04:
      sudo /opt/caspida/upgrade/utils/upgrade_ubuntu.sh -t 20.04
    3. Reboot the system:
      sudo reboot
  11. Run the UBA upgrade script, using the path to your archived UBA from step 2. Migrate your configurations in a tmux shell just in case your SSH connection breaks.

    The path-to-prev-uba-archive might be /var/vcap/release_archives/caspida- depending on your archived UBA version number.

    $ tmux
    $ /opt/caspida/upgrade/utils/upgrade_uba.sh -p <path-to-prev-uba-archive> -e /home/caspida/uba-ext-pkgs-5.2.0.tgz
    The command installs the new Splunk UBA software, restarts Splunk UBA, and then restarts the data sources.

If you have previously imported an output connector certificate, re-import the certificate. See, Configure the Splunk platform to receive data from the Splunk UBA output connector in the Send and Receive Data from the Splunk Platform manual.

Re-import the certificate used for sending UBA audit events to Splunk ES

If you have enabled the integration that sends UBA audit data to Splunk Enterprise Security (ES), and you preserved the associated certificate in the Before you begin step, you can now re-import that certificate. Use the following command to re-import the certificate:

. /opt/caspida/bin/CaspidaCommonEnv.sh
sudo keytool -import -alias "splunk es" -keystore $JAVA_HOME/lib/security/cacerts -file ~/splunk-es_cacert.pem

Troubleshoot the Ubuntu upgrade

While upgrading Ubuntu some environment specific issues can arise. See the following known issues and how to work around them.


You might encounter the following error message if snapd is in an unexpected state:

FileNotFoundError: [Errno 2] No such file or directory: 'snap'

Workaround steps:

  1. Remove and purge the snapd package:
    sudo apt purge snapd
  2. Reinstall the snapd package:
    sudo apt install snapd
  3. Re-run the upgrade_ubuntu.sh script.

Next steps

Verify a successful upgrade of Splunk UBA.

Last modified on 19 May, 2023
Upgrade Splunk UBA prerequisites
Upgrade a single node RHEL installation of Splunk UBA

This documentation applies to the following versions of Splunk® User Behavior Analytics: 5.2.0

Was this documentation topic helpful?

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