doc: Update acrn-manager README and QoS introduction

Modify 'launch_UOS.sh' to 'launch_uos.sh' and provide an example for
the script which is support '-C' option.

Signed-off-by: ruix.li <ruix.li@intel.com>
This commit is contained in:
ruix.li 2019-06-26 12:09:31 +08:00 committed by David Kinder
parent 5bee933885
commit 680edd1d3c
2 changed files with 21 additions and 4 deletions

View File

@ -104,7 +104,7 @@ How to use ACRN-DM QoS
}, },
.. note:: For configuration details, refer to the `Open Containers configuration documentation .. note:: For configuration details, refer to the `Open Containers configuration documentation
<https://github.com/opencontainers/runtime-spec/blob/master/config.md>`_. <https://github.com/opencontainers/runtime-spec/blob/master/config.md>`_.
#. Add the UOS by ``acrnctl add`` command: #. Add the UOS by ``acrnctl add`` command:
@ -112,8 +112,20 @@ How to use ACRN-DM QoS
# acrnctl add launch_uos.sh -C # acrnctl add launch_uos.sh -C
.. note:: You can download an `example launch_uos.sh script
<https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/devicemodel/samples/nuc/launch_uos.sh>`_
that supports the ``-C`` (``run_container`` function) option.
#. Start the UOS by ``acrnd`` #. Start the UOS by ``acrnd``
.. code-block:: none .. code-block:: none
# acrnd -t # acrnd -t
#. After UOS boots, you may use ``runc list`` command to check the container status in SOS:
.. code-block:: none
# runc list
ID PID STATUS BUNDLE CREATED OWNER
vm1 1686 running /usr/share/acrn/conf/add/runc/vm1 2019-06-27T08:16:40.9039293Z #0

View File

@ -41,17 +41,22 @@ Add a VM
======== ========
The ``add`` command lets you add a VM by specifying a The ``add`` command lets you add a VM by specifying a
script that will launch a UOS, for example ``launch_UOS.sh``: script that will launch a UOS, for example ``launch_uos.sh``:
.. code-block:: none .. code-block:: none
# acrnctl add launch_UOS.sh -U 1 # acrnctl add launch_uos.sh -U 1
vm1-14:59:30 added vm1-14:59:30 added
If a ``-C`` option is also specified, the VM is launched in a runC If a ``-C`` option is also specified, the VM is launched in a runC
container:: container::
# acrnctl add launch_UOS.sh -C # acrnctl add launch_uos.sh -C
.. note:: You can download an `example launch_uos.sh script
<https://raw.githubusercontent.com/projectacrn/acrnhypervisor/master/devicemodel/samples/nuc/launch_uos.sh>`_
that supports the ``-C`` (``run_container`` function) option. You may refer to :ref:`acrn-dm_qos`
for more details about this option.
Note that the launch script must only launch one UOS instance. Note that the launch script must only launch one UOS instance.
The VM name is important. ``acrnctl`` searches VMs by their The VM name is important. ``acrnctl`` searches VMs by their