Commit Graph

328 Commits

Author SHA1 Message Date
fuzhongl
19f8cc9af3 Doc:Update Logical Partition Getting Started Guide
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-04 09:55:06 -07:00
Victor Sun
c6a28daebc doc: update vm configuration related path
After vm configurations moved to acrn-hypervisor/misc/vm_configs,
some documents need to be updated.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-08-04 09:26:26 -07:00
fuzhongl
aabcf94ebf Doc: Getting Started Guide Update for hybrid mode
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-08-03 18:22:45 -07:00
Tao Yuhong
b1ca987650 Doc: The user guide for Pre-Launched RT mode
Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-29 10:14:46 -07:00
Vijay Dhanraj
cd1b133ac5 doc: update documentation for configuring ACRN RDT features
Given the recent changes in the way ACRN configures RDT features,
this patch updates the documentation as well to provide clear
guidelines to the user.

Tracked-On: #5063
Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-07-28 13:27:46 -07:00
Henning Schroeder
a524148ca1 Doc: fixing the intel_pstate kernel command line setting
Signed-off-by: Henning Schroeder <henning.schroeder@intel.com>

There seems to be a typo in the documentation.
2020-07-28 13:26:05 -07:00
David B. Kinder
854d8fa46e doc: tweak link in waag tutorial
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-04 14:35:56 -07:00
fangfang.shen
880be9f7ef doc:update WaaG GSG based on Ubuntu.
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-07-04 14:05:10 -07:00
David B. Kinder
cfad047bd0 doc: update broken link to AGL download
Tracked-On: #4504

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-19 15:02:03 -07:00
David B. Kinder
d479894ce4 doc: restore lists inside of notes
Lists inside of a note are displayed properly now, thanks to #4966 so
let's put some back in.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-18 13:54:00 -07:00
David B. Kinder
922129cad4 doc: consistent spelling of passthrough
Attempt to replace all the variations of "pass-thru", "pass thru", "pass
through", and "pass-through" to be "passthrough" (except for doc labels
and in code or API uses)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-18 12:46:26 -07:00
Victor Sun
780c87d9da doc: add hv parameter usage
The hv parameter could be configured in GRUB menu, currently we support
"uart=" parameter to override uart settings.

The patch also has modifications on tutorial of using_grub.

Signed-off-by: Victor Sun <victor.sun@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-17 21:10:42 -07:00
Victor Sun
5119fa0673 doc: add using grub tutorial
The GRUB could be used to boot ACRN hypervisor in direct boot mode.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-06-17 21:10:42 -07:00
David B. Kinder
91cbe6c984 doc: fix presentation of kata containers tutorial
Fixed a few layout issues and added link to mailing list

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-16 12:24:47 -07:00
Geoffroy Van Cutsem
398d639fa5 doc: Update Kata Containers tutorial to ACRN v2.0
Update the "Run Kata Containers on a Service VM" tutorial to use ACRN v2.0. It
also uses Ubuntu 20.04 as the baseline instead of Ubuntu 18.04. The Kata
Containers installation method is different as there are no pre-built binaries
for Ubuntu 20.04 yet, so using the 'kata-deploy' approach instead which is more
generic.

Changed link to slideshare.net for the referenced TCM presentation.

Tracked-On: #4944
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-16 12:00:48 -07:00
David B. Kinder
0ad80d1f09 doc: fix misspelling
Fix misspellings in docs missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-12 16:54:32 -07:00
Deb Taylor
b896137afa Doc: Edits to the acrn configuration tool
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-06-12 15:27:57 -04:00
Wei Liu
19f629a2fa doc: update acrn_configuration_tool tutorial for RDT feature
update acrn_configuration_tool tutorial for RDT and update uos type
for launch configuration tutorial.

Signed-off-by: Wei Liu <weix.w.liu@intel.com>
2020-06-12 13:46:43 -04:00
Geoffroy Van Cutsem
e49e79a05c doc: fix broken links to pre-built images (release 1.6.1)
Fix broken download links to the Service VM and RTVM images that are provided
for ACRN release 1.6.1.

Tracked-On: #4918
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-06-09 08:19:33 -07:00
Junming Liu
f1d08791b7 doc:Refine GVT-d tutorial
refine GVT-d tutorial

Signed-off-by: Junming Liu <junming.liu@intel.com>
2020-06-08 20:37:47 -07:00
Tonny Tzeng
99e41c279b doc: add dependencies for building the acrn-libvirt independently
This commit adds the required dependencies for building the acrn-libvirt
from source. The missing packages were installed for building the ACRN
source code, it's no harm to `apt install` the packages if they are
already installed, but this commit make the build of acrn-libvirt
independently.

Tracked-On: #4910
Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
2020-06-08 10:01:02 -07:00
David B. Kinder
6f00cd9a85 doc: tweak kata tutorial pre-requisites
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-05 09:26:22 -07:00
Tonny Tzeng
d9672639dc doc: specify component versions used by Kata-on-ACRN tutorial
This commit calls out specific configurations used for the validation.

Tracked-On: #4879
Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
2020-06-05 08:27:01 -07:00
David B. Kinder
764d7c1332 doc: rename rt_industry GSG
Move the rt_industry GST into a tutorial for using Clear Linux as the
Service VM.  Also drop a redirect to avoid 404 errors reference the
moved doc (redirect list maintained in conf.py)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-04 08:10:02 -07:00
David B. Kinder
1e2d0f3993 doc: update Kata tutorial for Ubuntu Service VM
Update tutorial for running Kata containers on Ubuntu

Tracked-On: #4879

Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-03 15:20:54 -07:00
David B. Kinder
db454dcdf1 doc: rst syntax tweaks
There are some subtle syntax errors in some documents that, while they
render OK (most of the time), are being caught by rstcheck (a
restructuredText linter). This PR fixes most of the issues encountered.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-03 14:37:37 -07:00
Vijay Dhanraj
cc952f73de Update doc/tutorials/acrn_on_qemu.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-29 09:10:42 -07:00
Vijay Dhanraj
2d6868d041 Update doc/tutorials/acrn_on_qemu.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-29 09:10:42 -07:00
Vijay Dhanraj
c0447aaad2 Update doc/tutorials/acrn_on_qemu.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-29 09:10:42 -07:00
Vijay Dhanraj
a81f6e2c62 doc: Enabling ACRN on top of QEMU/KVM
Tracked-On: #3198
Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-05-29 09:10:42 -07:00
Deb Taylor
c606d060ec Doc: Grammatical edits to GVT-d docs.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-21 17:17:16 -04:00
David B. Kinder
102aba8bc8 doc: Add visual OpenStack setup instructions
Update the OpenStack/libvirt tutorial with detailed instructions with
screen shots. Add patch file mention in the instructions to the docs
area so it's accessible.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-21 08:48:36 -07:00
Junming Liu
3ccbb20087 doc:add tutorial about enabling GVT-d
Previous tutorial "Enable GPU Passthrough on the Skylake NUC"
is out of date, so delete it here.

v2 -> v1:
add attached file

Signed-off-by: Junming Liu <junming.liu@intel.com>
2020-05-20 11:58:19 -04:00
Zide Chen
87adc93c96 doc: update cpu affinity related docs
Signed-off-by: Zide Chen <zide.chen@intel.com>
2020-05-18 11:13:37 -04:00
Yuan Liu
a99858e9f6 doc: Update acrn edk2 download path
Update acrn edk2 source code download path for WaaG
secure boot feature

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-05-14 08:50:55 -07:00
guoqingxz
fb65c42468 doc: update build ACRN doc
Signed-off-by: guoqingxz <guoqingx.q.zhang@intel.com>
2020-05-11 09:31:24 -04:00
fangfang.shen
2db40c9956 doc: update GSG for ACRN V1.6.1.
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-05-10 14:35:54 -07:00
David B. Kinder
5850f00880 doc: update libvirt guide
Clean up command-line formatting, reduce line length, prepare for
further technical review.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-08 08:32:41 -07:00
Conghui Chen
d7e1f570d4 doc: cpu-sharing doc update
Update cpu-sharing document.

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2020-05-08 08:31:17 -07:00
Deb Taylor
bfe2a1c525 Doc: Initial file: Config ACRN using OpenStack & libvert
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-07 16:12:10 -04:00
David B. Kinder
765e40bdb1 doc: edit notes on serial connection need
Clarify wording on tutorial notes about needing a serial port connection.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-07 10:08:21 -07:00
Geoffroy Van Cutsem
7689b92ed0 doc: update Zephyr document to indicate a serial port is needed
Update the "Run Zephyr as the User VM" document to add a note indicating a
serial port connection to the platform may be needed to see the Zephyr output
depending on the scenario  used (SDC vs. industrial).

Tracked-On: #4553
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-07 08:52:11 -07:00
Geoffroy Van Cutsem
a69a5608da doc: add note to the Celadon User VM tutorial
Add a note to the "Run Celadon as the User VM" tutorial to indicate a serial
port connection to the platform (or change of the default config) may be needed
if the user uses a scenario other than SDC (the default one in the doc).

Tracked-On: #4554
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-07 08:51:41 -07:00
David B. Kinder
c431199f41 doc: fix misspellings
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-05 09:07:45 -07:00
David B. Kinder
b0c7993309 doc: remove stray UTF-8 characters
Convert UTF-8 characters (typically pasted from Word for smart quotes
and such) into equivalent ASCII characters.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-04 16:16:32 -07:00
Deb Taylor
1df539b76c Doc: Updated "Advanced Guides" titles for naming consistency
Updated WaaG file

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-04 13:17:02 -04:00
David B. Kinder
f9824261e6 doc: fix broken link to touch monitor
Fixes: #4503

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-04 09:35:30 -07:00
Conghui Chen
dcb809e824 doc: update cpu-sharing doc
change IORR to BVT, update affinity related info.

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2020-05-03 17:00:03 -07:00
Victor Sun
1675dabddc doc: build from source update
As acrn-hypervisor Makefile rule changed, the doc need to be changed
accordingly.

Signed-off-by: Victor Sun <victor.sun@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-03 16:34:08 -07:00
Victor Sun
829083c46f doc: hv elements update
The hypervisor configuration is integrated into scenario XML now,
update the elements description for hv section.

Some elements in launch XML are updated also.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-05-03 16:34:08 -07:00