acrn-hypervisor/misc/sample_application
Junjie Mao 3f0eb96d85 sample_app: Add scripts to create RT and HMI VM images
Creating VM images is always a pain to users, and it is especially the case
for those who want to set up the ACRN sample application which needs two
different VM images, one with graphical desktop and the other optimized for
real-time.

This patch introduces the so-called "image builder" utility which is a set
of scripts that can automate the creation of those VM images. The scripts
will take care of:

  - Forking image files based on Ubuntu cloud images and enlarge the root
    file system per needs.

  - Setting up users and passwords.

  - Installing necessary packages to run either the graphical desktop or
    real-time applications.

  - Specific to the RT VM image, disabling services and tweaking kernel
    command line for optimized real-time performance.

  - Copying the sample applications into the images so that users can
    start them directly, after they launch the VMs.

Tracked-On: #7820
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2022-08-08 08:26:43 +08:00
..
image_builder sample_app: Add scripts to create RT and HMI VM images 2022-08-08 08:26:43 +08:00
rtvm SampleApplication: Add Makefile for the entire SampleApplication 2022-08-04 14:22:39 +08:00
uservm SampleApplication: Change the unit of result 2022-08-05 10:35:10 +08:00
Makefile SampleApplication: Add Makefile for the entire SampleApplication 2022-08-04 14:22:39 +08:00
README.rst doc: include sample app doc but unhook from toctree 2022-07-20 09:36:03 +08:00

:orphan:

.. _sample-app:

ACRN Sample Application
#######################

This directory contains a software application that runs a real-time
application between a real-time VM and a standard VM using the
acrn-hypervisor.

The ``rtvm`` directory contains the code that reads and pipes data from
``cyclictest`` to the User VM using the inter-vm shared memory feature that
acrn-hypervisor exposes to its VMs.

The ``uservm`` directory contains the code that reads the piped data from the
RTVM, processes the data, and displays the data over a web application that
can be accessed from the hypervisor's Service VM.

To build and run the applications, copy this repo to your VMs, run make in the
directory that corresponds to the VM that you are running, and then follow the
sample app guide in the acrn-hypervisor documentation.

For more information, please go to: https://github.com/projectacrn/acrn-hypervisor/wiki/ACRN-Sample-App