From 680edd1d3c69ff2d660eab3e5b145e833d36df7c Mon Sep 17 00:00:00 2001 From: "ruix.li" Date: Wed, 26 Jun 2019 12:09:31 +0800 Subject: [PATCH] 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 --- doc/tutorials/acrn-dm_QoS.rst | 14 +++++++++++++- tools/acrn-manager/README.rst | 11 ++++++++--- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/doc/tutorials/acrn-dm_QoS.rst b/doc/tutorials/acrn-dm_QoS.rst index 4cb415af8..aacbab11b 100644 --- a/doc/tutorials/acrn-dm_QoS.rst +++ b/doc/tutorials/acrn-dm_QoS.rst @@ -104,7 +104,7 @@ How to use ACRN-DM QoS }, .. note:: For configuration details, refer to the `Open Containers configuration documentation - `_. + `_. #. Add the UOS by ``acrnctl add`` command: @@ -112,8 +112,20 @@ How to use ACRN-DM QoS # acrnctl add launch_uos.sh -C + .. note:: You can download an `example launch_uos.sh script + `_ + that supports the ``-C`` (``run_container`` function) option. + #. Start the UOS by ``acrnd`` .. code-block:: none # 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 diff --git a/tools/acrn-manager/README.rst b/tools/acrn-manager/README.rst index beefa228d..957aaf3cd 100644 --- a/tools/acrn-manager/README.rst +++ b/tools/acrn-manager/README.rst @@ -41,17 +41,22 @@ Add a VM ======== 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 - # acrnctl add launch_UOS.sh -U 1 + # acrnctl add launch_uos.sh -U 1 vm1-14:59:30 added If a ``-C`` option is also specified, the VM is launched in a runC container:: - # acrnctl add launch_UOS.sh -C + # acrnctl add launch_uos.sh -C + +.. note:: You can download an `example launch_uos.sh script + `_ + 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. The VM name is important. ``acrnctl`` searches VMs by their