Add docs for QEMU

docs/requirements.txt

@@ -18,7 +18,10 @@ spurplus>=2.3.4
 semver>=2.13.0
 pep8-naming>=0.12.0
 types-toml>=0.1.5
-Pillow>=8.3.1
+Pillow>=9.0.0
+azure-storage-file-share>=12.4.0
+libvirt-python>={'version': '^7.10.0', 'platform': 'linux'}
+pycdlib>=1.12.0
 Sphinx>=4.1.0
 sphinx-argparse>=0.2.5
 sphinx-rtd-theme>=0.5.2

docs/run_test/platform.rst

@@ -9,6 +9,8 @@ Run tests on different platforms
 
 -  `Run on Ready computers <#run-on-ready-computers>`__
 
+-  `Run on Linux and QEMU <#run-on-linux-and-qemu>`__
+
 Run on Azure
 ------------
 
@@ -128,3 +130,32 @@ Learn more from :doc:`runbook reference <runbook>`.
 For a comprehensive introduction to LISA supported test parameters and runbook
 schema, please read :doc:`command-line reference <command_line>` and
 :doc:`runbook reference <runbook>`.
+
+Run on Linux and QEMU
+---------------------
+
+You can run the tests on Linux machine that has QEMU and KVM installed.
+
+Currently, only the `CBL-Mariner <https://github.com/microsoft/CBL-Mariner>`_ distro
+is supported. But it should be fairly straightforward to extend support to other
+distros. Also, only the the tier 0 tests are currently supported.
+
+For CBL-Mariner:
+
+1. Acquire a VHDX image of CBL-Mariner.
+
+   For example, you can build your own by following the
+   `VHDX and VHD images <https://github.com/microsoft/CBL-Mariner/blob/main/toolkit/docs/quick_start/quickstart.md#vhdx-and-vhd-images>`_
+   build instructions.
+
+2. Convert image from VHDX to qcow2:
+
+   .. code:: bash
+
+      qemu-img convert -f vhdx -O qcow2 "<vhdx file>" "<qcow2 file>"
+
+3. Run LISA with the parameters below:
+
+   .. code:: bash
+
+      ./lisa.sh  -r ./microsoft/runbook/qemu/CBL-Mariner.yml -v "admin_private_key_file:<private key file>" -v "qcow2:<qcow2 file>"