QuickStart Guide
...
Installation and Deployments
ISO Installation on Hypervisor...

KVM

14min

You can use KVM with QEMU emulator version 2.11.1 (Debian 1:2.11+dfsg-1ubuntu7.34) or later to install Litmus Edge.

CautionThis installation has been validated using QEMU version 2.11.1 on host OS Ubuntu 20.04 and 22.04. While newer versions of QEMU configurations may work, they have not been officially tested or guaranteed. Use newer versions at your own discretion, and ensure proper testing in your environment.

Before You Begin

  • You must have access to QEMU emulator version 2.11.1 (Debian 1:2.11+dfsg-1ubuntu7.34) or a later version, and OS Ubuntu 20.04 or 22.04.
  • Make sure you have the appropriate user permissions to use the QEMU Virtual Machine Manager.

To use QEMU Emulator KVM to install Litmus Edge, you will need to do the following.

  • Step 1: Create a Virtual Machine
  • Step 2: Configure Settings
  • Step 3: Install KVM
  • Step 4: Log in to Litmus Edge

To jump to a specific section, refer to the Table of Contents on the right side and click the corresponding step.

Step 1: Create a Virtual Machine

You will first need to create the virtual machine that will run Litmus Edge.

To create the virtual machine:

  1. From the QEMU emulator, open the Virtual Machine Manager.
  2. Click File and select New Virtual Machine. The Create a new virtual machine - step 1 dialog box appears.

Create a new virtual machine - step 1

To complete step 1:

  1. From the Create new virtual machine - step 1 dialog box, select Local install media (ISO image or CDROM).
  2. Click Forward. The Create a new virtual machine - step 2 dialog box appears.

Create a new virtual machine - step 2

To complete step 2:

  1. From the Create a new virtual machine - step 2 dialog box, select Use ISO image.
  2. Click Browse. The Choose storage volume dialog box appears.
  3. Click Browse Local.
  4. Navigate to the ISO file and click double-click the file. The path for the image appears in the field.
  5. Click Forward. The Create new virtual machine - step 3 dialog box appears.

Create a new virtual machine - step 3

To complete step 3:

  1. From the Create new virtual machine - step 3 dialog box, enter 4096 in the Memory (RAM) field.
  2. Enter 2 in the CPUs field.
  3. Click Forward. The Create new virtual machine - step 4 dialog box appears.

Create a new virtual machine - step 4

To complete step 4:

  1. From the Create new virtual machine - step 4 dialog box, select Create a disk image for the virtual machine.
  2. Enter 20.0 in the field.
  3. Click Forward. The Create a new virtual machine - step 5 dialog box appears.

Create a new virtual machine - step 5

To complete step 5:

  1. From the Create a new virtual machine - step 5 dialog box, enter a name for the virtual machine.
  2. Under Storage, select Customize configuration before install.
  3. Click the Expand (v) icon next to Network selection. The network selection box drops down.
  4. From the options. select Host device enp2s0: macvtap. The source mode selection box drops down.
  5. From the options, select Bridge.
  6. Click Finish. The <VMName> on QEMU/KVM dialog box appears.

Step 2: Configure Settings

After installing the virtual machine, you will need to configure its settings.

To configure the settings:

  1. Navigate to the Overview tab in the left panel.
  2. From the Firmware drop-down list, Select UEFIx86_64: /usr/share/OVMF/_CODE.fd.
  3. Click Apply.
  4. From the left panel, select IDE Disk 1.
  5. From the IDE Disk 1 pane, click the Expand (v) icon next to Advanced options. The disk fields drop down.
  6. From the Disk bus drop-down list, select SATA.
  7. Click Apply.
  8. Click Begin Installation. The Creating Virtual Machine dialog box appears and begins the installation.
  9. Click the dialog box to open the KVM OS installation application.

Step 3: Run the Operating System Installer

You will run the operating system installer that will install Litmus Edge.

Notes:

  • During the installation, the progress bar may decrease at times due to partitioning.
  • The time to complete the installation is based on the size of the hard disk drive. Large disk drives will cause the installation to take longer to partition the disk and therefore longer to complete setting up the virtual machine.

To install KVM:

  1. From the Welcome screen, enter No and then press ENTER.

    KVM OS Installer start up screen.
    KVM OS Installer start up screen.
    
  2. Select Install Operating System, and then select Ok.

    Install Operating System option
    Install Operating System option
    
  3. Select the partition to install, and then select Ok. This list is device specific. Typically, the installation location is sda. If the device/gateway has embedded MMC (eMMC) components, the partition name may be listed as mmcblk instead of sda. Make sure you select the correct hard-drive location.

    Select partition option
    Select partition option
    
  4. Verify the OS installation location by selecting Yes. If you select No, you are returned to the beginning of the installation.

    Installation verification
    Installation verification
    
  5. A second verification ensures that you are overwriting the correct device partition during the formatting process. Select Yes to continue formatting the device and installing the operating system.

    Warning message for installatio
    Warning message for installatio
    
  6. The installer indicates its progress, followed by a success message.

    Installation progress bar
    Installation progress bar
    
  7. Select Yes to power off the device.

    Power off notification
    Power off notification
    
  8. Reboot the device. The terminal window displays the URL which must be used to access the device using the Web UI.

Note: If several URLs are displayed, the first one is used for accessing the device through the Web UI.

Step 4: Configure TUI Settings

To configure the TUI settings:

  1. Press Left Control+ Left Alt to release the pointer on the TUI. The TUI settings appear.
  2. Navigate to the TUI settings.
  3. From the Keyboard Layout setting, select US, and then select Apply.

    Keyboard settings
    Keyboard settings
    
  4. From the Authentication setting, enter the following credentials and log in. Username: admin Password: litmusedge

    Login screen
    Login screen
    
  5. Scroll to the bottom of the license agreement and proceed.
  6. From the Change Password screen, enter the existing and new password and select Change.

    Change password screen.
    Change password screen.
    
  7. From the Authentication screen, enter admin as the username, your new password, and select Log in.

    

    Authentication screen
    Authentication screen
    
  8. From the System settings screen, select Configure Interfaces, and then select Next.

Step 5: Log in to Litmus Edge