Commit Graph

87 Commits

Author SHA1 Message Date
Min Yang c7907f244a doc: add "Linux" and "ACRN" to grub display in GSG
Add "Linux" before kernel version, and "ACRN" before acrn version.

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-12-22 15:39:20 -08:00
Min Yang 9d2e72f5ea doc: add kernel version to grub menuentry in GSG
1. add kernen version to menuentry "Ubuntu-ACRN Board Inspector"
2. add kernel version and acrn version to menuentry
   "Ubuntu with ACRN hypervisor"

Please refer to #8357(master) and #8358(release_3.2) for code change.

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-12-12 11:09:16 -08:00
Min Yang 1961718a6e doc: update grub menu set when reboot into ACRN in GSG
1. modify GRUB file /etc/default/grub
2. update GRUB menu after rebooting
3. update the UOS kernel

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-12-12 11:09:16 -08:00
David B. Kinder eca702ecf8 doc: update GSG with v3.2 changes
* install all Debian packages from /tmp (not ~/acrn-work)
* remove use of USB stick to copy files between dev and target (use scp)
* fix kernel version numbers (5.15.44 to 5.15.77)
* update parameters for debian_build.sh
* remove display of GRUB menu (ACRN now takes over target and
  automatically boots into hypervisor then Service VM

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-29 10:26:41 -08:00
Min Yang 03236c1de6 doc: update SGS and Sample App to match release 3.2
1. update grub item in SGS
2. update acrn kernel version
3. update file names

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-11-29 09:27:19 -08:00
David B. Kinder 23b36bae45 doc: update GSG to reflect release 3.2 changes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-24 12:00:56 -08:00
Min Yang 6634ab3ca1 docs: modify getting-started.rst
1.modify the board inspector name
2.add sudo before reboot (user: acrn)

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-11-23 09:46:57 -08:00
David B. Kinder 2ae578eaaf doc: update GSG with corrections
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-21 23:00:39 -08:00
szhen11 f8ec216df7 doc: update GSG to use debuild to build ACRN packages
Signed-off-by: szhen11 <shuang.zheng@intel.com>
2022-11-21 22:30:29 -08:00
David B. Kinder 4f0bc815ac doc: update missed changes to Ubuntu 22.04
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-10-31 06:55:29 -07:00
zhangrouyu c9a836aed8 update ubuntu version from 20.04.5 to 22.04.1 in GSG document
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-10-28 06:57:08 -07:00
zhangrouyu 5a452e5e32 Create a requirements.txt for python package on GSG
Tracked-On: #8269
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-10-27 16:15:40 +08:00
zhangrouyu ee0a1b0f1c doc:Modify the tqdm package problem in the GSG document
We have real fix in PR#8222, thus remove the workround in document.
delete the command: sudo pip3 install tqdm

Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
Tracked-On:8155
2022-10-18 15:04:11 -07:00
zhangrouyu 6a1acd7b5e revision the GSG document of ubuntu kernel version
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-30 09:07:38 -07:00
zhangrouyu 5a1e1fd6b4 supplement to revision
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-19 09:42:48 -07:00
Reyes, Amy 96baec68c0 doc: Minor GSG edits
- Minor editorial changes
- Improve image quality
- Delete unused image

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-16 15:38:11 -07:00
zhangrouyu 34776484df GSG document revision 2022-09-16 13:28:14 -07:00
David B. Kinder d96656e4ad doc: fix typo in GSG
missing a trailing backslash on a command continuation

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-26 14:22:37 -07:00
David B. Kinder a1281b9085 doc: update GSG and sample app guide
* Fix missing /build folder in copy command in GSG
* Mention USB stick needs formatting for large files when used for the
  sample app (but we'll put that into GSG too).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-25 15:01:46 -07:00
David B. Kinder 2addfe9ca1 doc: update GSG to include scp instructions
Make the GSG more consistent with the sample app doc and show how to use
scp to transfer files between the dev and target machines.

Also add a mention of the sample app guide at the end of the GSG.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-24 17:27:00 -07:00
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 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 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
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
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
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
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