.. 
   LISA documentation master file, created by
   sphinx-quickstart on Tue Jun 29 13:51:04 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Linux Integration Services Automation (LISA)!
========================================================

|CI Workflow| |GitHub license| |Docs|

**Linux Integration Services Automation (LISA)** is a Linux quality
validation system, which consists of two parts:

-  A test framework to drive test execution.
-  A set of test suites to verify Linux kernel/distribution quality.

**LISA** was originally designed and implemented for Microsoft Azure and
Windows HyperV platforms; now it can be used to validate Linux quality
on any platforms if the proper orchestrator module implemented.

Why LISA
--------

-  **Scalable**: Benefit from the appropriate abstractions, **LISA**
   can be used to test the quality of numerous Linux distributions
   without duplication of code implementation.

-  **Customizable**: The test suites created on top of **LISA** can be
   customized to support different quality validation needs.

-  **Support multiple platforms**: **LISA** is created with modular
   design, to support various of Linux platforms including Microsoft
   Azure, Windows HyperV, Linux bare metal, and other cloud based
   platforms.

-  **End-to-end**: **LISA** supports platform specific orchestrator to
   create and delete test environment automatically; it also provides
   flexibility to preserve environment for troubleshooting if test
   failed.

.. toctree::
   :maxdepth: 1
   :hidden:

   Introduction <quick_start>
   Installation & Update <install>
   Run tests <run_test/run>
   Write tests <write_test/write>
   Contributing <contributing>
   Troubleshooting <troubleshooting>

Road map
--------------------

LISA is in active developing, and a lot of exciting features are implementing.
We're listening your `feedback
<https://github.com/microsoft/lisa/issues/new>`__.

License
-------

The entire codebase is under `MIT license
<https://github.com/microsoft/lisa/blob/main/LICENSE>`__.

.. |CI Workflow| image:: https://github.com/microsoft/lisa/workflows/CI%20Workflow/badge.svg?branch=main
   :target: https://github.com/microsoft/lisa/actions?query=workflow%3A%22CI+Workflow+for+LISAv3%22+event%3Apush+branch%3Amain
.. |GitHub license| image:: https://img.shields.io/github/license/microsoft/lisa
   :target: https://github.com/microsoft/lisa/blob/main/LICENSE
.. |Docs| image:: https://readthedocs.org/projects/mslisa/badge/?version=main
   :target: https://mslisa.readthedocs.io/en/main/?badge=main
   :alt: Documentation Status