Install Splunk UBA on a single VMware virtual machine
Follow these instructions to install Splunk UBA 5.0.0 or 5.0.3 for the first time using the OVA image. 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.
Perform the following steps to install Splunk UBA on a single VMware virtual machine.
- Download the Splunk UBA open virtual appliance (OVA) from Splunkbase. See Splunk UBA OVA Software.
- Deploy the Splunk UBA OVA on your virtual machine.
- Provision the virtual machine with three disks, one with 50GB of disk space and the other two with 1TB of disk space. Make sure that the 1TB disks are associated with the OVA.
- Log in to the virtual machine as the caspida user using SSH.
Specify
caspida123
as the existing default password. You will be prompted to provide the default password a second time, and then change the existing password. For example:ssh caspida@ubahost-001.example.com caspida@ubahost-001.example.com's password: You are required to change your password immediately (root enforced) Changing password for caspida. (current) UNIX password: Enter new UNIX password: Retype new UNIX password: caspida$
After changing the password you may be logged out. Log in to the virtual machine again using your new credentials. - 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.caspida@ubahost-001$ 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. - The Splunk UBA OVA files contain the default
hostname
variable set tocaspida
. This must be changed to reflect the actual host name of the server.- Use
sudo
to edit the/etc/hostname
file and change the host namecaspida
to the short host name value of the server. For example, if your server isserver1.company.com
, replacecaspida
withserver1
. - Run the following command to have changes take effect without a restart:
sudo hostname -F /etc/hostname
If you get an error, run the command again to allow the changes to take effect.
Test your changes using the
hostname
command and verifying the following:- The host name of the server is the one you configured, and not
caspida
. - The host name can be resolved by DNS.
- Use
- Find the two additional 1TB disks using the
sudo fdisk -l
command. An example disk is/dev/sdb
. - Format and mount the additional 1TB disks associated with the OVA.
- Add the additional 1TB disk for Splunk UBA metadata storage. For example, using
/dev/sdb
as the 1TB disk:
Verify that the disk is/opt/caspida/bin/Caspida add-disk /dev/sdb
/var/vcap
. Refer to your Linux documentation if you prefer to add a disk manually without using theadd-disk
command. - Add the additional 1TB disk for Spark. The disk should be mounted as
/var/vcap2
. Use the/opt/caspida/bin/Caspida add-disk <device> <mount>
command. For example:/opt/caspida/bin/Caspida add-disk /dev/sdc /var/vcap2
- Add the additional 1TB disk for Splunk UBA metadata storage. For example, using
- Verify that IPv6 drivers are available. To do this, check that
/proc/sys/net/ipv6/
exists. For example:caspida@ubahost-001$ 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, verify that
/etc/default/grub
containsipv6.disable=1
. In some cases, IPv6 drivers will not be on a system ifipv6.disable=1
exists in/etc/default/grub
. Ifipv6.disable=1
does not exist in/etc/default/grub
and IPv6 drivers do not exist, consult with your system or network administrators. You are not 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.
- Remove
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 disables the IPv6 addressing. - 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
- Copy the keys to the server. Enter the password for the caspida user when prompted for the password.
ssh-copy-id <host name>
- Test the SSH connection is passwordless.
ssh `hostname` <== Note the backquotes around hostname ssh localhost
- Run the following command to install or upgrade libjson-perl:
sudo apt-get install libjson-perl
- 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>
- Set up Splunk UBA.
/opt/caspida/bin/Caspida setup
- When prompted, accept the license agreement and confirm removal of existing metadata.
- When prompted, type the host name, or the IP address of the Splunk UBA server installation.
- When prompted, confirm that you want to continue setting up Splunk UBA.
- 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
Install Splunk User Behavior Analytics | Install Splunk UBA on a single m4 Amazon Web Services instance |
This documentation applies to the following versions of Splunk® User Behavior Analytics: 5.0.0, 5.0.1, 5.0.2, 5.0.3, 5.0.4, 5.0.4.1, 5.0.5, 5.0.5.1
Feedback submitted, thanks!