Splunk® User Behavior Analytics

Install and Upgrade Splunk User Behavior Analytics

This documentation does not apply to the most recent version of Splunk® User Behavior Analytics. For documentation on the most recent version, go to the latest release.

Upgrade a single node RHEL, CentOS, or Oracle Linux installation of Splunk UBA

Before upgrading Splunk UBA on a single server, be sure you have verified the Upgrade Splunk UBA prerequisites.

Single server upgrade steps

Perform the following tasks to upgrade Splunk UBA on a single server.

  1. Download the new version of Splunk UBA from Splunkbase. The file name is splunk-uba-software-upgrade-package_500.tgz . See Splunk UBA Software Update on Splunkbase.
  2. Copy the Splunk UBA package to /home/caspida directory.
  3. Log in to the Splunk UBA server as the caspida user using SSH.
  4. Extract the file you just downloaded. 
    tar -xvf /home/caspida/splunk-uba-software-upgrade-package_500.tgz

    The following files are extracted to the splunk-uba-software-update_50 directory:

    • Splunk-UBA-Platform-5.0.0-20191015-000100.tgz
    • Splunk-UBA-Platform-5.0.0-20191015-000100.tgz.md5sum
    • uba-ext-pkgs-5.0.0.tgz
    • uba-ext-pkgs-5.0.0.tgz.md5sum

    Move all of these files to the /home/caspida directory: 

    mv splunk-uba-software-update_50/* /home/caspida
  5. Stop Splunk UBA with the following command: 
    /opt/caspida/bin/Caspida stop-all
  6. If you are using the Splunk UBA Kafka Ingestion App, download and upgrade to version 1.2 of the Splunk UBA Kafka Ingestion App. During the upgrade, select the Upgrade app. Checking this will overwrite the app if it already exists. checkbox to upgrade the app without restarting Splunk Enterprise. See Install the Splunk UBA Kafka Ingestion App in the Splunk UBA Kafka Ingestion App manual.
  7. Update to the latest kernel. See Operating system requirements for the specific kernel versions.
    Operating System Update Instructions
    OEL 7.7
    1. Run the following commands to enable the repos for required packages: 
      sudo subscription-manager repos --enable=rhel-7-server-extras-rpms
sudo subscription-manager repos --enable=rhel-7-server-eus-rpms
sudo subscription-manager repos --enable=rhel-7-server-rpms
sudo subscription-manager repos --enable=rhel-7-server-optional-rpms
    2. Run the following command to install yum-utils: 
      sudo yum install yum-utils -y
    3. Run the following commands to skip certain packages if they are not available: 
      sudo yum-config-manager --disable pgdg94
sudo yum-config-manager --disable nodesource
sudo yum-config-manager --disable rhel-7-server-rt-beta-rpms
    4. Obtain http://yum.oracle.com/public-yum-ol7.repo and download it to /home/caspida. 
      wget http://yum.oracle.com/public-yum-ol7.repo /home/caspida
    5. Copy public-yum-ol7.repo to /etc/yum.repos.d: 
      sudo cp /home/caspida/public-yum-ol7.repo /etc/yum.repos.d/public-yum-ol7.repo
    6. Enable the repositories: 
      sudo yum-config-manager --enable ol7_UEKR5
sudo yum-config-manager --enable ol7_addons
    7. Run the following command to update the kernel: 
      yum update --releasever=7.7 --exclude="zookeeper redis-server redis-tools influxdb nodejs nodejs-docs postgres*" -y
    RHEL 7.7
    1. Run the following commands to enable the repos for required packages: 
      sudo subscription-manager repos --enable=rhel-7-server-extras-rpms
sudo subscription-manager repos --enable=rhel-7-server-eus-rpms
sudo subscription-manager repos --enable=rhel-7-server-rpms
sudo subscription-manager repos --enable=rhel-7-server-optional-rpms
    2. Run the following command to install yum-utils: 
      sudo yum install yum-utils -y
    3. Run the following commands to skip certain packages if they are not available: 
      sudo yum-config-manager --disable pgdg94
sudo yum-config-manager --disable nodesource
sudo yum-config-manager --disable rhel-7-server-rt-beta-rpms
    4. Run the following command to update the kernel: 
      yum update --releasever=7.7 --exclude="zookeeper redis-server redis-tools influxdb nodejs nodejs-docs postgres*" -y
    CentOS 7.7

    Run the following command to update your CentOS kernel to the latest version: 

    sudo yum update -y

    Perform the following tasks to upgrade your CentOS kernel to a specific version:

    1. Save /etc/yum.repos.d to a backup location.
    2. Enter the following code in a file so you can run it as a script: 
      for fname in $(ls -1 /etc/yum.repos.d/*.repo 2>/dev/null) ; do
   echo "Changing from mirrorlist to baseurl in ${fname}"
   sed -i -e 's/^mirrorlist/#mirrorlist/g' -e 's/^#baseurl/baseurl/g' "${fname}"
   [ $? -eq 0 ] || die "Failed to disable mirrorlist option for ${fname}"
   echo "Switching from standard mirror to vault mirror"
   sed -i -e "s|baseurl=http://mirror.centos.org/centos/\$releasever|baseurl=http://vault.centos.org/centos/${OS_VER_FULL}|g" "${fname}"
   [ $? -eq 0 ] || die "Failed to switch to vault URL in ${fname}"
done
    3. Update the baseurl in the /etc/yum.repos.d/Centos-Base.repo file with the specific version of the kernel you want to update to. In this example, we use 7.6.1810: 
      baseurl=http://vault.centos.org/centos/7.6.1810/os/$basearch/
    4. Run the following command to update the kernel: 
      sudo yum -y upgrade --releasever=${OS_VER_FULL} --exclude="${YUM_PKG_EXCLUDES}"
  8. If the kernel upgrade does not succeed, run the following command to restart the existing Splunk UBA services: 
    /opt/caspida/bin/Caspida start-all

    If the kernel upgrade is successful, reboot Splunk UBA:

    sudo /sbin/reboot
  9. Run the following command to start all Splunk UBA services: 
    /opt/caspida/bin/Caspida start-all --no-caspida
  10. Run the following commands to archive the previous version of Splunk UBA. 
    sudo mkdir -p /var/vcap/release_archives
sudo mv /opt/caspida /var/vcap/release_archives/caspida-4.3.x
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-4.3.x
  11. Extract the Splunk UBA platform package in the /opt/caspida directory. 
    tar -C /opt/caspida -xvf /home/caspida/Splunk-UBA-Platform-5.0.0-20191015-000100.tgz
  12. Run the upgrade script to upgrade Splunk UBA to the new version and migrate your configurations. The upgrade script can take some time, and there are options for ensuring that the process is not interrupted:
    • If you have a terminal multiplexer product such as Linux Screen, you can start a screen session before running the upgrade command. For example, run the following command to start a new screen session called ubainstall: 
      screen -S ubainstall

      Then run the upgrade script: 

      /opt/caspida/upgrade/utils/upgrade_4.3_to_5.0.sh -p /var/vcap/release_archives/caspida-4.3.x -e /home/caspida/uba-ext-pkgs-5.0.0.tgz
      Refer to your product documentation for additional usage instructions.
    • Use nohup to run the upgrade script. For example: 
      nohup /opt/caspida/upgrade/utils/upgrade_4.3_to_5.0.sh -p /var/vcap/release_archives/caspida-4.3.x -e /home/caspida/uba-ext-pkgs-5.0.0.tgz &

      To view the progress of the upgrade using >nohup, use the following command to monitor the log messages being written to nohup.out: 

      tail -f nohup.out
  13. After the upgrade script finishes running, use the following command and look for the "Upgrade completed & started Caspida" confirmation message: 
    tail -f /var/log/caspida/upgrade.out

Next Steps

Verify a successful upgrade of Splunk UBA.

Last modified on 29 November, 2022
Upgrade a single node AMI or OVA installation of Splunk UBA   Upgrade a distributed AMI or OVA installation of Splunk UBA

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

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