Commit Graph

274 Commits

Author SHA1 Message Date
Zhang Wei
31f92eba63 doc: Add a python package in GSG
The Getting Started Guide specifies that we need to install the Python packages lxml, xmlschema, and defusedxml.
However, a make clean involves the execution of the Python script manager.py. This script imports the package requests.py, which might not be installed if the developer follows the Getting Started Guide.

Add requests follow this command in GSG.
sudo pip3 install "elementpath==2.5.0" lxml "xmlschema==1.9.2" defusedxml tqdm requests

[External_System_ID] ACRN-9144
Tracked-On: #8029
Signed-off-by: Zhang Wei <wei6.zhang@intel.com>
2022-08-22 10:03:30 -07:00
David B. Kinder
f4ef01dc2c doc: update sample app guide
* Fix preempt-rt patched kernel label on wrong VM
* Fix path copying hmi_vm.img and rt_vm.img (they're not in ~/acrn-work
  directory)
* Rename png images to avoid potential conflicts with other images on the
  system.
* Fix Ubuntu wecome message text after logging into RT_VM

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-19 11:39:54 -07:00
Liu Long
b9c4d2622c ACRN: Doc: Modify the SampleApplication document
1. Add the move iasl binary to the /usr/sbin directory.
2. Modify login RT_VM user to root user.

Signed-off-by: Liu Long <long.liu@linux.intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 21:31:51 -07:00
David B. Kinder
a7edf92ae4 doc: update sample app user guide
After review with engineering, we added material for showing what a
successful hmi_vm.img build ending looks like (and a hint of what to do
if it looks like the build failed.  Also added using a dhclient commmand
to the instructions in case the HMI_VM didn't get an IP address.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 18:03:40 -07:00
David B. Kinder
7c05b055d7 doc: fix typos in sample app guide
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 16:45:21 -07:00
David B. Kinder
0b938933db doc: add sample application user guide
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 15:36:29 -07:00
David B. Kinder
c88076d9ef doc: revert to not using requirements.txt in the GSG
GSG was recently updated to use a requirements.txt for python
dependencies, but that file doesn't exist in the repo at the v3.0 tag
the instructions say to use.  Revert to not use a requirements.txt until
we get this figured out.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-17 16:58:00 -07:00
zihengL1
b026238a69 config-tools: modified requirements.txt and update GSG
Modified requirements.txt in misc/config_tools/configurator
directory and add GSG requirements.txt inmisc/config_tools
directory.
Relevant python package installing steps in GSG.

Tracked-On: #7975
Reviewed-by: Junjie Mao junjie.mao@intel.com
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-08-16 17:20:23 +08:00
David B. Kinder
a9bf1afc08 doc: fix order of steps in GSG setup
Edits preparing for using a requirements.txt introduced an error in the
step order (using a directory before it was created).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-15 20:25:40 -07:00
David B. Kinder
0d36e754e9 doc: add libelf-dev dependency to GSG
The new acrn-kernel for v3.1 expects gelf.h that's installed with the libelf-dev
package that's not listed as a dependency in the GSG.  Without this
package, building acrn-kernel fails.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-13 11:28:40 -07:00
David B. Kinder
5bc94cf08a doc: clarify and improve GSG
Update Getting Started Guide to clarify and improve descriptions of
steps, including adding example commands instead of just describing
them, adding more information about system requirements, making certain
steps explicit, squash the long list of packages to install into fewer
lines, and more.

Move cloning ACRN hypervisor and kernel earlier in the instructions
(anticipating use of a requirements.txt coming from the repo).

[External_System_ID] ACRN-9285

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-11 17:11:52 -07:00
David B. Kinder
364295e0d8 doc: update GSG version for xmlschema
While we're waiting for a more complete list of specific package version
requirements, let's fix the xmlschema and elementpath version mismatch
now.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-10 13:39:34 -07:00
David B. Kinder
785ce3346c doc: add proxy note to GSG
Remind readers that internet access from a corporate network typically
requires configuring proxy information.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-09 09:22:29 -07:00
zihengL1
82d4f633ed doc: fix Build EFI-Stub fail problem
In the "Enable ACRN Secure Boot With EFI-Stub" guide, to build EFI-Stub
smoothly, the installation of "gnu-efi" package is added to GSG.

Tracked-On: #7935
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-08-09 09:20:16 -07:00
David B. Kinder
c6fcda2a0d doc: add configurator error handling to GSG
Explain that consistency and validation checks of the schema are done
when a schema is imported/created or when it's saved, and after you
resolve any errors, you need to save the scenario to force another
schema validation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-07-19 13:37:33 -07:00
David B. Kinder
4aa871effc doc: elementpath version must be 2.5.0 in the GSG
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-07-07 13:12:41 -07:00
Kunhui-Li
c7ca50131c doc: update GSG picture
update GSG picture.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-06-29 22:27:47 -07:00
David B. Kinder
a90d8e5114 doc: fix gsg instructions for building the acrn-kernel
You need to be in the acrn-kernel directory in order to ``run make
distclean``  Also, remove mention of 6 VMs ...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 22:12:11 -07:00
David B. Kinder
b787f3ba7d doc: update acrn-kernel repo tag
acrn-kernel tag (for v3.0 hypervisor) should be acrn-v3.0

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 12:49:49 -07:00
David B. Kinder
258f42440a doc: update GSG with Configurator debian download
Add instructions for downloading the configurator debian package and
installing it.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 12:28:38 -07:00
Kunhui-Li
74a67fbcd4 doc: update GSG
1. add link for ACRN configurator
2. update deb name.
3. update the patch of launch script.
4. update Python package dependencies.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-06-29 09:05:41 -07:00
Reyes, Amy
26b2b8ca2a doc: Update GSG
- Update v3.0 tag for acrn-hypervisor
- Update virtio console description
- Update screenshots

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-27 22:30:53 -07:00
jackwhich
8c0070a531 doc: Update GSG/Hybrid HW pic
Update GSG/Hybrid HW pic and release_3.0 version

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-06-24 17:29:57 -07:00
Reyes, Amy
bcb82c0c4d doc: Update Config Overview
- Regarding post-launched VMs, update the messaging about static vs. dynamic. Dynamic is more about creating a VM at runtime per PR 7802, not changing the configuration of an existing VM at runtime.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-24 10:06:22 -07:00
Reyes, Amy
b34eb9ad1b doc: Update GSG HW pic and typo
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-17 16:20:32 -07:00
David B. Kinder
6c35bb535d doc: update doc to use sudo with systemctl command
systemctl won't run as a normal Linux user, requires sudo

Also augment the description information

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-16 20:58:38 -07:00
Reyes, Amy
990ca9be06 doc: Update GSG
- Update Configurator UI steps
- Emphasize connecting USB devices
- Use release_3.0 branch until tag is created
- Fix typos

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-16 13:42:17 -07:00
Qiang Zhang
f941180fcb doc: add doc for required systemd services
"systemd-networkd" is required for acrn-dm to create bridge device.
Document it in GSG before acrn network deb package is ready.

Tracked-On: #7738
Signed-off-by: Qiang Zhang <qiang4.zhang@intel.com>
2022-06-13 21:41:07 -07:00
Reyes, Amy
200c554a5e doc: Update Configuration and Development Overview
- Align with new Configurator design, and use of Configurator instead of editing predefined XMLs

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-08 09:18:24 -07:00
Yuanyuan Zhao
b24ff3debf config_tools: merge python packages list for configurator
Merge python packages list into one 'requirements.txt'.
And modify related document.

Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-06-08 12:53:51 +08:00
Yuanyuan Zhao
f7d80168cd doc: GSG's python dependence
For config_tools use python to clear dirty files, add python dependence
while prepare development computer.

Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-06-08 12:53:51 +08:00
Reyes, Amy
f4b217b059 doc: remove unused images from get-started folder
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-12 11:41:58 -07:00
Shiqing Gao
f8de4178e4 doc: update GSG for virtio-gpu dependency libraries
commit 78f702e ("Use libdrm library for drm access") adds the dependency on
libdrm library. GSG needs to be updated accordingly. Otherwise, compilation
error occurs like below:
hw/pci/virtio/virtio_gpu.c:21:10: fatal error: libdrm/drm_fourcc.h: No such file or directory
   21 | #include <libdrm/drm_fourcc.h>
      |          ^~~~~~~~~~~~~~~~~~~~~
compilation terminated.

Tracked-On: #7464

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2022-05-11 22:00:49 -07:00
Reyes, Amy
c16ee09727 doc: Remove acrn quick setup script
- This script is outdated. The last time it was used was v2.0.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-06 16:08:08 -07:00
Reyes, Amy
049a01c638 doc: Remove outdated ClearLinux Docker file
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-06 16:07:01 -07:00
Chenli Wei
288c6853f4 doc: fix the make configurator fails issue
The current code need python3.8-venv to build some modules, so we
should add these requirement to "Getting Started Guide".

This patch modify the getting-started.rst to generate new guide.

Signed-off-by: Chenli Wei <chenli.wei@intel.com>
2022-05-06 11:41:47 -07:00
David B. Kinder
e491773f5e doc: remove obsolete (and orphaned) docs
We removed some documentation from the table of contents but left them
around in the published documentation.  All of these documents are
obsolete and haven't been updated since they were last validated on
earlier versions of ACRN.  (They all can still be referenced in the
older version archives if needed.)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-05-03 15:16:46 -07:00
Reyes, Amy
ca3251a47d doc: Update Configurator steps
- Add build steps
- Update steps per new UI

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-03 15:16:21 -07:00
Reyes, Amy
d881276fee doc: Add note to GSG about optional upgrade
- Add comment in upgrade command in case users ignore description above command

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-04-18 17:18:14 -07:00
Sun Peng
e8934aeb41 doc: virtio-gpu dependency libraries
Add virtio-gpu dependency libararies in getting-started documents.

Tracked-On: #7210
Reviewed-by: Zhao Yakui <yakui.zhao@intel.com>
Signed-off-by: Sun Peng <peng.p.sun@linux.intel.com>
2022-03-28 15:26:20 +08:00
Reyes, Amy
04eefc9516 doc: Add poweroff step to gsg
- Add an optional step in GSG to power off User VM.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-21 17:21:36 -07:00
Reyes, Amy
4eb14e7a0d doc: Update Getting Started Guide
- Update to Ubuntu 20.04
- Add Debian pkg usage.
- Modify mem parameter in launch xml to 1024M.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-16 18:16:17 -07:00
jackwhich
5c5fbd6a5b doc: revert gsg libcjson dependency
Add gsg to install libcjson-dev dependency notes

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-03-09 13:53:37 -08:00
David B. Kinder
0283202193 doc: fix docs with missing newline at EOF
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-28 12:16:18 -08:00
jackwhich
bd02de15b0 doc: Remove modprobe msr in gsg
modprobe msr has been added to board_parse.py in PR #6692.

Remove modprobe msr in gsg and board_inspector docs

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-02-22 09:45:29 -08:00
Xiangyang Wu
53dd2954d2 doc: add libcjson-dev installation in GSG
Libcjson package is needed to build command monitor of DM,
so this should be installed in the user's development machine.

Tracked-On: #5921

Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2022-02-18 18:33:52 +08:00
Reyes, Amy
e09968e5e4 doc: Update Debian packaging readme
- Update doc for v2.8 release

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-10 12:43:59 -08:00
Geoffroy Van Cutsem
21d7b242c9 doc: update the method to run the acrn_configurator.py
Update the instructions on how to start the ACRN Configurator tool
('acrn_configurator.py'). It is no longer require to use 'python3 ...'
since we've added a shebang header to the file and made it executable.

Tracked-On: #7057
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2022-01-26 14:20:43 +08:00
Yuanyuan Zhao
75884af9ac doc: remove dm dynamic param '-A'
Update document to remove 'acrn-dm' dynamic param '-A'.

Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-21 16:07:37 -08:00
Reyes, Amy
a62e468aab doc: Update images
- Update images to align better with ACRN branding

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-01-21 16:04:45 -08:00