The following procedures explain how to deploy an ExtraHop Explore virtual appliance on a Linux kernel-based virtual machine (KVM). You should be familiar with basic KVM administration before proceeding.
If you need either the installation package files or a license key for the virtual appliance, contact firstname.lastname@example.org.
|Important:||If you want to deploy more than one ExtraHop virtual appliance, create the new instance with the original deployment package or clone an existing instance that has never been started.|
Your environment must meet the following requirements to deploy a virtual Explore appliance:
- A KVM hypervisor environment capable of hosting the Explore virtual appliance. The
Explore virtual appliance is available in the following configurations:
EXA-XS EXA-S EXA-M EXA-L 4 CPUs 8 CPUs 16 CPUs 32 CPUs 8GB RAM 16 GB RAM 32 GB RAM 64 GB RAM 4 GB boot disk 4 GB boot disk 4 GB boot disk 4 GB boot disk 500 GB or smaller datastore disk 1.2 TB or smaller datastore disk 2.5 TB or smaller datastore disk 4.1 TB or smaller datastore disk Note: When you deploy an Explore appliance, a second virtual disk is required to store record data. The EXA-XS is preconfigured with a 500 GB datastore disk; however, you must manually add a second virtual disk to the other available EXA configurations. The minimum datastore disk size for all configurations is 150 GB.
Consult with your ExtraHop sales representative or Technical Support to determine the datastore disk size that is best for your needs.
Note: For KVM deployments, virtio-scsi interface is recommended for the boot and datastore disks.
- An Explore virtual appliance license key.
- The following TCP ports must be open:
- TCP ports 80 and 443: Enables you to administer the Explore appliance through the Web UI. Requests sent to port 80 are automatically redirected to HTTPS port 443.
- TCP port 9443: Enables Explore nodes to communicate with other Explore nodes in the same cluster.
The installation package for KVM systems is a tar.gz file that contains the following items:
- The domain XML configuration file
- The boot disk
- The datastore disk
To deploy the Explore virtual appliance, complete the following procedures:
Identify the bridge through which you will access the management interface of your Explore appliance.
- Make sure the management bridge is accessible to the Explore virtual appliance and to all users who must access the management interface.
- If you need to access the management interface from an external computer, configure a physical interface on the management bridge.
After you identify the management bridge, edit the configuration file, and create the Explore virtual appliance.
- Contact ExtraHop Support (email@example.com) to obtain and download the Explore KVM package.
- Extract the tar.gz file that contains the installation package.
- Copy the two disks extrahop-boot.qcow2 and extrahop-data.qcow2 to your KVM system. Make a note of the location where you store these files.
Open the domain XML configuration file in a text editor and edit the following
Change the VM name to a name for your ExtraHop virtual appliance.
Change the source file path ([PATH_TO_STORAGE]) to the
location where you stored the virtual disk files in step 3.
<source file='[PATH_TO_STORAGE]/extrahop-boot.qcow2'/> <source file='[PATH_TO_STORAGE]/extrahop-data.qcow2'/>
Change the source bridge for the management network
(ovsbr0) to match the name of your management
<interface type='bridge'> <source bridge='ovsbr0'/> <model type='virtio'/> <alias name='net0'/> <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/> </interface>
(Optional) If your virtual bridge is configured through Open vSwitch
virtual switch software, add the following virtualport type setting to
the interface (after the source bridge setting):
<virtualport type='openvswitch'> </virtualport>
- Change the VM name to a name for your ExtraHop virtual appliance.
- Save the XML file.
Create the new Explore virtual appliance with your revised domain XML
configuration file by running the following command:
virsh define <EXA_KVM_x.xml>Where <EXA_KVM_x.xml> is the name of your domain XML configuration file.
Resize the datastore disk so that the allotted space is large enough to store the type of records you want to store for the amount of lookback desired.
qemu-img resize extrahop-data.qcow2 <+nGB>
qemu-img resize extrahop-data.qcow2 +100GB
Start the VM by running the following command:
virsh start <vm_name>Where <vm_name> is the name of your ExtraHop virtual appliance you configured in step 4 of the Edit the domain XML file section.
Log in to the KVM console and view the IP address for your new ExtraHop virtual
appliance by running the following command:
sudo virsh console <vm_name>
After you obtain the IP address for the Explore appliance, log into the Explore Admin UI through the following URL: https://<explore_ip_address>/admin and complete the following recommended procedures.
|Note:||The default log in name is setup and the password is default.|
Complete the following steps to apply a product key supplied by ExtraHop Support.
|Tip:||To verify that your environment can
resolve DNS entries for the ExtraHop licensing server, open a terminal application
on your Windows, Linux, or Mac OS client and run the following
nslookup -type=NS d.extrahop.com
If the name resolution is successful, output similar to the following appears:
Non-authoritative answer: d.extrahop.com nameserver = ns0.use.d.extrahop.com. d.extrahop.com nameserver = ns0.usw.d.extrahop.com.
- In your browser, type the URL of the ExtraHop Admin UI, https://<extrahop_ip_address>/admin.
- Review the license agreement, select I Agree, and then click Submit.
- On the login screen, type setup for the username.
For the password, select from the following options:
- For 1U and 2U appliances, type the service tag number found on the pullout tab on the front of the appliance.
- For the EDA 1100, type the serial number displayed in the Appliance info section of the LCD menu. The serial number is also printed on the bottom of the appliance.
- For a virtual appliance, type default.
- Click Log In.
- In the System Settings section, click License.
- Click Manage License.
- Click Register.
- Enter the product key and then click Register.
- Click Done.
Before you beginLog into the Admin UI of each Explore node, click Fingerprint in the Status section, and note the value listed in the Fingerprint field. The fingerprint of each node should be verified during the join process.
If you are deploying three or more Explore nodes, join the nodes to create a cluster.
|Important:||Each node that you join must have the same configuration (physical or virtual) and ExtraHop firmware version.|
- Log into the Admin UI of any new Explore node.
- In the Cluster Settings section, click Join Cluster.
- In the Host text box, type the hostname or IP address of any of the other new nodes and then click Continue.
- Verify that the fingerprint displayed on the page matches the fingerprint of the Explore node that you are joining. If these fingerprints do not match, communication between the nodes might have been intercepted and altered.
- In the Setup Password field, type the password for the setup user.
- Click Join.
- In the Status section, click Cluster Status.
- Wait for the Status field to change to green.
Repeat steps 1 - 8 to join each additional node to the new cluster.
Note: Always join a new node to the existing cluster and not another unjoined node, or you will create multiple clusters.
- Click Cluster Members in the Cluster Settings section to confirm that all of the nodes are listed on the page.
By default, the Explore appliance synchronizes the system time through the pool.ntp.org network time protocol (NTP) server. If your network environment prevents the Explore appliance from communicating with this time server, you must configure an alternate time server source.
|Note:||Time synchronization is critical to ensuring proper cluster operations and maintaining consistent views of data across both Discover and Explore appliances. We strongly recommend that you either keep the default system time setting or configure settings for a different NTP server.|
- In the System Settings section, click System Time.
- Click Configure Time.
- Click the Time Zone drop-down list and select a time zone. Click Save and Continue.
- Select the Use NTP server to set time radio button and then click Select.
- Type the IP addresses for the time server, and then click Save.
- Click Done.
- Click Sync Now to sync system time on the Explore appliance with the remote time server.
You must configure an email server and sender before the ExtraHop appliance can send notifications about system alerts by email.
- A virtual disk is in a degraded state.
- A physical disk is in a degraded state.
- A physical disk has an increasing error count.
- A registered Explore node is missing from the cluster. The node might have failed, or is powered off.
After you deploy the Explore cluster, you must establish a connection from all ExtraHop Discover and Command appliances to the Explore cluster before you can query records. If you manage all of your Discover appliances from a Command appliance, you only need to perform this procedure from the Command appliance.
|Important:||If you have an Explore cluster, pair the Discover appliance to each Explore node so that the Discover appliance can distribute the workload across the entire Explore cluster.|
- Log into the Discover or Command appliance Admin UI.
- In the ExtraHop Explore Settings section, click Configure Explore Cluster.
- Click Add New.
- In the Host #1 Host field, type the hostname or IP address of any Explore appliance in the Explore cluster.
- For each additional Explore appliance in the cluster, click Add New and enter the individual hostname or IP address in the corresponding Host field.
- Click Save.
- Note the information listed for Fingerprint. Verify that the fingerprint listed on this page matches the fingerprint of the Explore appliance (Host #1) listed on the Fingerprint page in the Explore Admin UI.
- In the Explore Setup Password field, type the password of the Explore appliance.
- Click Join, and then click Done.
After your Explore appliance is paired with all of your Discover and Command appliances, you must configure the type of records you want to store. See the following documentation for more information about Explore configuration settings, how to generate and store records, and how to create record queries.