Skip to main content

Install locally

This page explains how to install on a local machine using the installable USB flash drive image.

Requirements

  • USB flash drive (>= 16GB)
  • UEFI x86-64 system
  • Target SSD

Preparing the Installation Media

  1. Download the latest USB installation image from the following URL:

    https://images.collabora.com/facebook/resctl-demo-latest/resctl-demo-flasher-efiboot.img.gz

  2. Uncompress the image and write the image to a USB drive:

    • On Linux, if sdX is the USB drive:

      gunzip resctl-demo-flasher-efiboot.img.gz
      sudo dd if=resctl-demo-flasher-efiboot.img of=/dev/sdX bs=1M oflag=direct status=progress

      Alternatively, if you have bmaptool installed, you can combine the download and imaging steps into one:

      bmaptool copy https://images.collabora.com/facebook/resctl-demo-latest/resctl-demo-flasher-efiboot.img.gz /dev/sdX
    • On Mac, use the Archive Utility to uncompress the image and dd to write the image to the USB drive. This raspberry pi document may be helpful.

    • Windows doesn't provide a built-in tool to write an image file to a USB device. Use a tool, such as Disk Imager.

Install from the USB drive

  1. Ensure that Secure Boot is disabled in BIOS.

  2. Plug in the prepared USB drive and reboot. Trigger the BIOS boot selection menu and select the USB drive. Refer to the motherboard manual for how to trigger the boot selection menu.

  3. GRUB menu will appear. Select Install resctl-demo.

  4. Once resctl-demo installer boots, choose the target disk to install into.

    WARNING: Everything on the drive will be wiped out.

  5. It will take a few minutes to copy the image to the target drive. Once installation completes, check for error messages and press Enter to reboot.

Boot and Start resctl-demo

  1. Trigger the boot selection menu and select the UEFI boot entry for the installed device.

  2. Select Debian GNU/Linux in the GRUB menu.

  3. Once the system boots, login with user demo and password demo and start resctl-demo by running ./start-resctl-demo. Have fun!

  4. If you want to configure network and access using ssh, configure network with nmtui(1) or nmcli(1). Note that the local installation image allows password login for ssh by default. Change the password if the machine is exposed to external network.