diff --git a/doc/tutorials/acrn_configurator_tool.rst b/doc/tutorials/acrn_configurator_tool.rst index 42ae95446..85cb3917f 100644 --- a/doc/tutorials/acrn_configurator_tool.rst +++ b/doc/tutorials/acrn_configurator_tool.rst @@ -8,7 +8,7 @@ This guide describes all features and uses of the tool. About the ACRN Configurator Tool ********************************* -The ACRN configurator tool ``acrn_configurator.py`` provides a web-based +The ACRN Configurator tool ``acrn_configurator.py`` provides a web-based user interface to help you customize your :ref:`ACRN configuration `. Capabilities: @@ -26,7 +26,7 @@ dependencies among the different types of configuration files. Here's an overview of what to expect: #. Import the board configuration file that you generated via the - :ref:`board inspector tool `. + :ref:`Board Inspector tool `. #. Customize your scenario configuration file by defining hypervisor and VM settings that will be used to build the ACRN hypervisor. @@ -39,19 +39,19 @@ overview of what to expect: a. Configure settings for all post-launched User VMs in your scenario and save the configuration in a launch configuration file. - #. Generate the launch scripts. The ACRN configurator creates one + #. Generate the launch scripts. The ACRN Configurator creates one launch script for each VM defined in the launch configuration file. Generate a Scenario Configuration File and Launch Scripts ********************************************************* -The following steps describe all options in the ACRN configurator for generating +The following steps describe all options in the ACRN Configurator for generating a custom scenario configuration file and launch scripts. #. Make sure the development computer is set up and ready to launch the ACRN - configurator, according to :ref:`gsg-dev-setup` in the Getting Started Guide. + Configurator, according to :ref:`gsg-dev-setup` in the Getting Started Guide. -#. Launch the ACRN configurator. This example assumes the tool is in the +#. Launch the ACRN Configurator. This example assumes the tool is in the ``~/acrn-work/`` directory. Feel free to modify the command as needed. .. code-block:: bash @@ -60,12 +60,13 @@ a custom scenario configuration file and launch scripts. #. Your web browser should open the website ``_ automatically, or you may need to visit this website manually. The ACRN - configurator is supported on Chrome and Firefox. + Configurator is supported on Chrome and Firefox. -#. Click the **Import Board XML** button and browse to your board - configuration file. After the file is uploaded, make sure the board name - is selected in the **Board info** drop-down list and the board information - appears. +#. Click the **Import Board XML** button and browse to the board + configuration file that you generated via the + :ref:`Board Inspector `. After the file is uploaded, + make sure the board name is selected in the **Board info** drop-down list + and the board information appears. #. Start the scenario configuration process by selecting an option from the **Scenario Settings** menu on the top banner of the UI or by importing a @@ -83,6 +84,7 @@ a custom scenario configuration file and launch scripts. .. image:: images/choose_scenario.png :align: center + :class: drop-shadow * Click the **Import XML** button to import a customized scenario configuration file. @@ -96,6 +98,7 @@ a custom scenario configuration file and launch scripts. .. image:: images/configure_scenario.png :align: center + :class: drop-shadow * You can edit these items directly in the text boxes, or you can choose single or even multiple items from the drop-down list. @@ -112,30 +115,32 @@ a custom scenario configuration file and launch scripts. * Click **Remove this VM** in a VM's settings to remove the VM from the scenario. - When a VM is added or removed, the configurator reassigns the VM IDs for + When a VM is added or removed, the ACRN Configurator reassigns the VM IDs for the remaining VMs by the order of pre-launched User VMs, Service VM, and post-launched User VMs. .. image:: images/configure_vm_add.png :align: center + :class: drop-shadow #. Click **Export XML** to save the scenario configuration file. A dialog box appears, enabling you to save the file to a specific folder by inputting the absolute path to this folder. If you don't specify a path, the file will be saved to the default folder: ``acrn-hypervisor/../user_config/``. - Before saving the scenario configuration file, the configurator validates - the configurable items. If errors exist, the configurator lists all + Before saving the scenario configuration file, the Configurator validates + the configurable items. If errors exist, the Configurator lists all incorrectly configured items and shows the errors. Example: .. image:: images/err_acrn_configuration.png :align: center + :class: drop-shadow After the scenario is saved, the page automatically displays the saved scenario configuration file. #. To delete a scenario configuration file, click **Export XML** > **Remove**. - The configurator will delete the loaded file, even if you change the name of + The Configurator will delete the loaded file, even if you change the name of the file in the dialog box. #. If your scenario has post-launched User VMs, continue to the next step @@ -158,6 +163,7 @@ a custom scenario configuration file and launch scripts. .. image:: images/choose_launch.png :align: center + :class: drop-shadow * Click the **Import XML** button to import a customized launch configuration file. @@ -171,6 +177,7 @@ a custom scenario configuration file and launch scripts. .. image:: images/configure_launch.png :align: center + :class: drop-shadow * You can edit these items directly in the text boxes, or you can choose single or even multiple items from the drop-down list. @@ -179,14 +186,15 @@ a custom scenario configuration file and launch scripts. * Hover the mouse cursor over the item to see the description. -#. Add or remove User VM (UOS) launch scripts: +#. Add or remove User VM launch scripts: - * Click **Configure an UOS below** to add a User VM launch script. + * Click **Configure a User VM below** to add a User VM launch script. * Click **Remove this VM** to remove a User VM launch script. .. image:: images/configure_launch_add.png :align: center + :class: drop-shadow #. Click **Export XML** to save the launch configuration file. A dialog box appears, enabling you to save the file to a specific folder by inputting the @@ -194,12 +202,12 @@ a custom scenario configuration file and launch scripts. be saved to the default folder: ``acrn-hypervisor/../user_config/``. - Before saving the launch configuration file, the configurator validates the - configurable items. If errors exist, the configurator lists all incorrectly + Before saving the launch configuration file, the Configurator validates the + configurable items. If errors exist, the Configurator lists all incorrectly configured items and shows the errors. #. To delete a launch configuration file, click **Export XML** > **Remove**. - The configurator will delete the loaded file, even if you change the name of + The Configurator will delete the loaded file, even if you change the name of the file in the dialog box. #. Click **Generate Launch Script** to save the current launch configuration @@ -208,6 +216,7 @@ a custom scenario configuration file and launch scripts. .. image:: images/generate_launch_script.png :align: center + :class: drop-shadow #. Confirm that the launch scripts appear in the ``/output`` directory. diff --git a/doc/tutorials/images/choose_launch.png b/doc/tutorials/images/choose_launch.png index c8351eafb..f55c39ec5 100644 Binary files a/doc/tutorials/images/choose_launch.png and b/doc/tutorials/images/choose_launch.png differ diff --git a/doc/tutorials/images/configure_launch.png b/doc/tutorials/images/configure_launch.png index f4ca0fce2..97a174756 100644 Binary files a/doc/tutorials/images/configure_launch.png and b/doc/tutorials/images/configure_launch.png differ diff --git a/doc/tutorials/images/configure_launch_add.png b/doc/tutorials/images/configure_launch_add.png index a3a2c3b6d..d36cdc519 100644 Binary files a/doc/tutorials/images/configure_launch_add.png and b/doc/tutorials/images/configure_launch_add.png differ diff --git a/doc/tutorials/images/err_acrn_configuration.png b/doc/tutorials/images/err_acrn_configuration.png index cf20fcffa..79a48244d 100644 Binary files a/doc/tutorials/images/err_acrn_configuration.png and b/doc/tutorials/images/err_acrn_configuration.png differ diff --git a/doc/tutorials/images/generate_launch_script.png b/doc/tutorials/images/generate_launch_script.png index e105b0a1b..2810cbe99 100644 Binary files a/doc/tutorials/images/generate_launch_script.png and b/doc/tutorials/images/generate_launch_script.png differ