Install Splunk UBA on a single Linux server
Install Splunk UBA on a server with Oracle Enterprise Linux (OEL) or Red Hat Enterprise Linux (RHEL) installed. Splunk UBA version 5.2.0 requires OEL version 8.7 or RHEL version 8.6.
Follow these instructions to install Splunk UBA 5.2.0 for the first time. If you already have Splunk UBA, do not follow the instructions on this page. Instead, follow the appropriate upgrade instructions to obtain your desired release. See, How to install or upgrade to this release of Splunk UBA.
Prerequisites
- You must install Splunk UBA on a server that is running a supported operating system. See, Operating system requirements.
- Make sure your Red Hat Enterprise Linux license includes the proper subscription names. See, Additional RHEL requirements.
- Determine the interface of your system network configuration, for example
eth0
,en0
, etc. You will need this information later in the installation process. - The
bind-utils
package must be installed on your system. Use the following command to install:
yum install bind-utils
Configure permissions for and prepare the caspida user
Enable sudo permissions for the caspida user.
- Use the
visudo
command to edit the/etc/sudoers
file. - If the following line exists, comment the line
Defaults requiretty
. - Add the following lines at the end of the
/etc/sudoers
file.Thecaspida ALL=(ALL) NOPASSWD:ALL Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin
/etc/sudoers
file is read sequentially, so placing these lines at the end ensures that there is no impact to the caspida user from any existing accounts or group permissions. - Add the caspida user to the system. For example, assuming UID and GID 2018 is available:
groupadd --gid 2018 caspida useradd --uid 2018 --gid 2018 -m -d /home/caspida -c "Caspida User" -s /bin/bash caspida
- Set the password for caspida user:
passwd caspida
- Verify the caspida user permissions for newly created files and directories. See Validate the UMASK value.
Obtain the installation package
Download the following Splunk UBA software and RHEL packages:
- Obtain the Splunk UBA 5.2.0 software:
- Go to the Splunk UBA Software Installation Package page on Splunkbase.
- Download the file to the
/home/caspida
directory. The name of the package issplunk-uba-software-installation-package_520.tgz
.
Use these packages for all supported Linux environments.
Prepare the server for the installation
- From the command line, log in to the server as the root user, or log in as a different user then use
su
orsudo
to gain root user privileges. - Find the 1TB disks using the
fdisk
command:Example disks might befdisk -l
/dev/sdb
and/dev/sdc
. - Partition and format the partition on each disk found in step 2.
- Partition and format the partition on the
/dev/sdb
disk using the following series of commands. Verify that thealign-check opt 1
command returns1 aligned
.parted -a optimal /dev/sdb mklabel gpt mkpart primary ext4 2048s 100% align-check opt 1 quit
- Format the partition using the
mkfs
command.mkfs -t ext4 /dev/sdb1
- Repeat the commands to partition and format the partition on
/dev/sdc
:parted -a optimal /dev/sdc mklabel gpt mkpart primary ext4 2048s 100% align-check opt 1 quit
- Format the partition using the
mkfs
command. When prompted, confirm that you want to continue.mkfs -t ext4 /dev/sdc1
- Partition and format the partition on the
- Get the block ID for each disk using the
blkid
command. For example, to get the block IDs for/dev/sdb1
and/dev/sdc1
in our example:An example block ID might be:blkid -o value -s UUID /dev/sdb1 blkid -o value -s UUID /dev/sdc1
5c00b211-e751-4661-91c4-60d9f9315857
. - Create new
/var/vcap
and/var/vcap2
directories.mkdir -p /var/vcap /var/vcap2
- Add the block IDs for the
/var/vcap
and/var/vcap2
partitions to the/etc/fstab
directory. For example:UUID=5c00b211-e751-4661-91c4-60d9f9315857 /var/vcap ext4 defaults 0 0 UUID=e10ab5c0-c27a-4617-8945-daab6d597731 /var/vcap2 ext4 defaults 0 0
- Mount the file systems.
mount -a
- Verify that the 1TB disks are mounted correctly using the
df -h
command. For example:root# df -h Filesystem Size Used Avail Use% Mounted on ... /dev/sdc1 493G 77M 467G 1% /var/vcap2 /dev/sdb1 985G 43G 892G 5% /var/vcap ...
- Inherit the permissions for the root user.
chmod 755 /var/vcap /var/vcap2 chown root:root /var/vcap /var/vcap2
- Make a directory for caspida software packages.
This should be different from caspida home directory (
/home/caspida
).mkdir /opt/caspida chown caspida:caspida /opt/caspida chmod 755 /opt/caspida
- Set the following environment variables for PostgreSQL in the
/etc/locale.conf
file:LANG="en_US.UTF-8" LC_CTYPE="en_US.UTF-8"
- Run the following command to source the /etc/locale.conf file:
source /etc/locale.conf
- Verify that the host name resolves using the
host <host name>
command. If it does not, verify your host name lookup and DNS settings. See, Configure host name lookups and DNS. - Modify
/etc/sysconfig/selinux
setSELINUX=permissive
.
With SELINUX set toenforced
, certain actions during installation and upgrade (for example, access to particular files) can be blocked. Set SELINUX topermissive
to allow Splunk UBA the necessary access so that actions are not blocked, but instead logged in the audit logs. - Verify that the system date, time and time zone are correct using the
timedatectl
command, as shown below. The time zone in Splunk UBA should match the time zone configured in Splunk Enterprise.root# timedatectl status Local time: Mon 2019-04-08 14:30:02 UTC Universal time: Mon 2019-04-08 14:30:02 UTC RTC time: Mon 2019-04-08 14:30:01 Time zone: UTC (UTC, +0000) NTP enabled: yes NTP synchronized: yes RTC in local TZ: no DST active: n/a
Use the
timedatectl
command to change the time zone. For example, to change the time zone to UTC:Refer to the documentation for your specific operating system to configure NTP synchronization. Use thetimedatectl set-timezone UTC
ntpq -p
command to verify that NTP is pointing to the desired server. - Verify that
/proc/sys/net/bridge/bridge-nf-call-iptables
exists on your system and the content ofbridge-nf-call-iptables
is1
. Run the following command to verify:cat /proc/sys/net/bridge/bridge-nf-call-iptables
Your situation Take this action /proc/sys/net/bridge/bridge-nf-call-iptables
exists on your system and the content is1
.- Run the following command to make sure this setting is preserved through any reboot operations:
echo net.bridge.bridge-nf-call-iptables=1 > /etc/sysctl.d/splunkuba-bridge.conf
- Go to Step 18.
/proc/sys/net/bridge/bridge-nf-call-iptables
exists on your system but the content is not1
.- Run the following commands to set the content of the
bridge-nf-call-iptables
:sysctl -w net.bridge.bridge-nf-call-iptables=1
- Run the following command to ensure that the settings persist through any reboot operations:
echo net.bridge.bridge-nf-call-iptables=1 > /etc/sysctl.d/splunkuba-bridge.conf
- Go to Step 18.
/proc/sys/net/bridge/bridge-nf-call-iptables
does not exist on your system.- Run the following commands to create the file and ensure that it is loaded on reboot:
modprobe br_netfilter echo br_netfilter > /etc/modules-load.d/br_netfilter.conf
- Run the following commands to create and set the content of the
bridge-nf-call-iptables
:sysctl -w net.bridge.bridge-nf-call-iptables=1
- Run the following command to ensure that the settings persist through any reboot operations:
echo net.bridge.bridge-nf-call-iptables=1 > /etc/sysctl.d/splunkuba-bridge.conf
- Go to Step 17.
- Run the following command to make sure this setting is preserved through any reboot operations:
- Run the following command to ensure that /etc/sysctl.d/splunkuba-bridge.conf is readable by the caspida user:
chmod o+r /etc/sysctl.d/splunkuba-bridge.conf
If that command returns without error, proceed to the next step.
- Verify that IPv6 drivers are available. To do this, check that
/proc/sys/net/ipv6/
exists. For example:root# ls -l /proc/sys/net/ipv6/ total 0 -rw-r--r-- 1 root root 0 Mar 12 16:52 anycast_src_echo_reply -rw-r--r-- 1 root root 0 Mar 12 16:52 auto_flowlabels -rw-r--r-- 1 root root 0 Mar 12 16:52 bindv6only dr-xr-xr-x 1 root root 0 Mar 12 16:52 conf -rw-r--r-- 1 root root 0 Mar 12 16:52 flowlabel_consistency -rw-r--r-- 1 root root 0 Mar 12 16:52 flowlabel_state_ranges -rw-r--r-- 1 root root 0 Mar 12 16:52 fwmark_reflect dr-xr-xr-x 1 root root 0 Mar 12 16:52 icmp -rw-r--r-- 1 root root 0 Mar 12 16:52 idgen_delay -rw-r--r-- 1 root root 0 Mar 12 16:52 idgen_retries -rw-r--r-- 1 root root 0 Mar 12 16:52 ip6frag_high_thresh -rw-r--r-- 1 root root 0 Mar 12 16:52 ip6frag_low_thresh -rw-r--r-- 1 root root 0 Mar 12 16:52 ip6frag_secret_interval -rw-r--r-- 1 root root 0 Mar 12 16:52 ip6frag_time -rw-r--r-- 1 root root 0 Mar 12 16:52 ip_nonlocal_bind -rw-r--r-- 1 root root 0 Mar 12 16:52 mld_max_msf -rw-r--r-- 1 root root 0 Mar 12 16:52 mld_qrv dr-xr-xr-x 1 root root 0 Mar 12 16:52 neigh dr-xr-xr-x 1 root root 0 Mar 12 16:52 route -rw-r--r-- 1 root root 0 Mar 12 16:52 xfrm6_gc_thresh
If the IPv6 drivers exist, skip to the next step.
If IPv6 drivers do not exist on your system, check if/etc/default/grub
containsipv6.disable=1
. IPv6 drivers will not be available on a system ifipv6.disable=1
exists in/etc/default/grub
. Ifipv6.disable=1
is not present in/etc/default/grub
and IPv6 drivers do not exist, consult with your system or network administrators. You will not be able to continue with the installation.
If/etc/default/grub
containsipv6.disable=1
, perform the following tasks as root:- Remove
ipv6.disable=1
from/etc/default/grub
. - Recreate the grub config:
grub2-mkconfig -o /boot/grub2/grub.cfg
- Reboot the machines. After the system comes up, make sure
/proc/sys/net/ipv6
exists.
To disable IPv6 functionality for security, networking or performance reasons, create the
/etc/sysctl.d/splunkuba-ipv6.conf
file as root. This file should contain the following content:net.ipv6.conf.all.disable_ipv6 = 1 net.ipv6.conf.default.disable_ipv6 = 1 net.ipv6.conf.lo.disable_ipv6 = 1
This procedure keeps the IPv6 drivers but disable the IPv6 addressing. - Remove
- Create the
/etc/security/limits.d/caspida.conf
file and add the following security limits for thecaspida
user to this file:caspida soft nproc unlimited caspida soft nofile 32768 caspida hard nofile 32768 caspida soft core unlimited caspida soft stack unlimited caspida soft memlock unlimited caspida hard memlock unlimited
Make sure the root account does not have any security limits.
- If you are not using IPv6 on your network, edit the
/etc/yum.conf
file and add the following entry so that only IPv4 addresses are used by yum/rpm:ip_resolve=4
- If you have any firewall configuration enabled, disable the configuration and verify that port 9002 is open. Run the following command:
You can re-enable your firewall settings after the setup is complete.
systemctl disable firewalld
- Restart the system.
init 6
- After the system restarts, use the following command to verify that the host name matches your host name lookup and DNS settings. See Configure host name lookups and DNS.
hostname --fqdn
Install Splunk UBA
Perform the following steps to install Splunk UBA.
- Log in to the command line as the caspida user using SSH.
- Verify that the caspida user has umask permissions set to 0022 or 0002.
umask
If the returned values are not supported, edit the
~/.bash_profile
and the~/.bashrc
files and append:umask 0022
- Copy the file for Splunk UBA Software Installation from Splunkbase to the
/home/caspida
directory. - Untar the file for Splunk UBA Software Installation in
/home/caspida
directory.tar xvzf /home/caspida/splunk-uba-software-installation-package_520.tgz
- Untar the Splunk UBA platform software to the
/opt/caspida
directory.tar xvzf /home/caspida/Splunk-UBA-Platform-5.2.0-20230202-8254784.tgz -C /opt/caspida/
- Untar the Splunk UBA Packages for RHEL to the
/home/caspida
directory.tar xvzf /home/caspida/Splunk-UBA-5.2-Packages-RHEL-8.tgz -C /home/caspida
- Run the installation script.
The log file is
/opt/caspida/bin/installer/redhat/INSTALL.sh /home/caspida/Splunk-UBA-5.2-Packages-RHEL-8
/var/log/caspida/install.log
. - If you see the following error, your OS has a newer version of the library
krb5-libs
and/orzlib
:krb5-libs(x86-64) = 1.18.2-21.0.1.el8 is needed by krb5-devel-1.18.2-21.0.1.el8.x86_64 krb5-libs(x86-64) = 1.18.2-21.0.1.el8 is needed by libkadm5-1.18.2-21.0.1.el8.x86_64 zlib(x86-64) = 1.2.11-20.el8 is needed by zlib-devel-1.2.11-20.el8.x86_64 on Redhat enterprise linux
- Fix this error by running the following commands to manually install:
sudo yum -y localinstall /home/caspida/Splunk-UBA-5.2-Packages-RHEL-8/extra_packages/rpm/hadoop/krb5-libs-1.18.2-21.0.1.el8.x86_64.rpm sudo yum -y localinstall /home/caspida/Splunk-UBA-5.2-Packages-RHEL-8/extra_packages/rpm/hadoop/zlib-1.2.11-20.el8.x86_64.rpm
- Then re-run the installation script
- Generate SSH keys using the
ssh-keygen -t rsa
command. Press enter for all the prompts and accept all default values. For example:[caspida@ubahost-001]$ ssh-keygen -t rsa Generating public/private rsa key pair. Enter file in which to save the key (/home/caspida/.ssh/id_rsa): Created directory '/home/caspida/.ssh'. Enter passphrase (empty for no passphrase): Enter same passphrase again: Your identification has been saved in /home/caspida/.ssh/id_rsa. Your public key has been saved in /home/caspida/.ssh/id_rsa.pub. The key fingerprint is: SHA256:Ohe1oSpUtNT8siJzvn2lFLrHmVH7JGKke+c/5NRFb/g caspida@ubahost-001
- Add the SSH keys to the server and adjust the permissions to allow the server to access them.
cat /home/caspida/.ssh/id_rsa.pub >> /home/caspida/.ssh/authorized_keys chmod 600 /home/caspida/.ssh/authorized_keys
- SSH to the server without a password using the host name or internal IP.
ssh <uba host name>; exit
- Check the system status with the
uba_pre_check.sh
shell script. Run the following command on a single-node deployment and be sure to replace<node1>
with the actual host name of your system.See Check system status before and after installation for more information about the script./opt/caspida/bin/utils/uba_pre_check.sh <node1>
- Run the setup script.
/opt/caspida/bin/Caspida setup
- When prompted, accept the license agreement and confirm removal of existing metadata.
- When prompted, type the host name of the Splunk UBA server installation. For example, type
uba01-prod
if uba01-prod is the host name of your Splunk UBA server. - When prompted, confirm that you want to continue setting up Splunk UBA.
- The log file is
/var/log/caspida/caspida.out
.
- Verify the host name of all the nodes using the following command:
hostname
- Make sure all the nodes have a consistent setup. If using fully qualified domain names (FQDN) then all nodes should output FQDN in the host name command. If the short name is used, then all nodes should output the short name in the host name command.
- If FQDN is used then in the pre_check script provide the FQDN of all the nodes, for example:
/opt/caspida/bin/utils/uba_pre_check.sh <NODE1_FQDN> <NODE2_FQDN> <NODE3_FQDN>
- When prompted for a list of host names in the setup script, if the output of the host name command is FQDN, then provide a CSV list of FQDN host names, for example:
<NODE1_FQDN>,<NODE2_FQDN>,<NODE3_FQDN>
- After setup completes:
- Open a web browser and log in to the Splunk UBA server with the default admin credentials to confirm a successful installation. The default username is
admin
and password ischangeme
. See Secure the default account after installing Splunk UBA for information about the default accounts provided with Splunk UBA and how to secure them. - See Verify successful installation for more information about verifying a successful installation.
- Open a web browser and log in to the Splunk UBA server with the default admin credentials to confirm a successful installation. The default username is
If you plan on connecting to Splunk Cloud to run queries for datasources, use fully qualified domain names (FQDN), not short names, for your Splunk UBA hostnames.
Install Splunk UBA on a single Amazon Web Services instance | Install Splunk UBA on several Amazon Web Services instances |
This documentation applies to the following versions of Splunk® User Behavior Analytics: 5.2.0
Feedback submitted, thanks!