Commit Graph

950 Commits

Author SHA1 Message Date
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
Deb Taylor 7fd535215d Grammatical updates to GSG Indust Scen Ubuntu
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-06-04 08:29:04 -04: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
Fuzhong Liu 78ba180987 Update doc/getting-started/rt_industry_ubuntu.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-06-03 17:52:31 -04:00
Deb Taylor acbc6848fc Initial GSG for ARCN industry Scenario with Unbuntu Service VM
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-06-03 17:52:31 -04: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
Geoffroy Van Cutsem 31ed8e27b0 doc: update note about min version of gcc and binutils
Update the note in the document to indicate the minimum version of gcc and
binutils required to succesfully compile ACRN.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-29 09:04:55 -07:00
Geoffroy Van Cutsem 0079184f97 doc: remove zlib from the build dependency
Remove the zlib package from the list of build dependencies for Ubuntu.

Tracked-On: #4838
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-29 09:04:55 -07:00
David B. Kinder 4db42c1c7f doc: fix rst-columns display
Using ``.. rst-class:: rst-columns`` wasn't processed correctly because
of an error in the acrn-custom.css file.  Fix that, update the
documentation guidelines, and make use of the multi-column display in
documents where the toctree created a long list.  Now it will
appear in columns.

Also tweaked the toctree listing to use bold for the first-level items
(making a multi-column display look better, particularly when it has
subsections).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-21 15:08:15 -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
Mingqiang Chi f994b5ffaf hv:cleanup vcpu state
-- remove VCPU_PAUSED and resume_vcpu
-- remove vcpu->prev_state in vcpu structure
-- rename pause_vcpu to zombie_vcpu

Tracked-On: #4320
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
2020-05-21 15:08:49 +08: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
Deb Taylor 9d3f2066c1 Doc: Grammatical edits to CPU Virtualization doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-18 19:03:52 -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
fuzhongl c271fc022a Doc: Supported hardware update
Update some scenario typo info for NUC6CAYH

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-05-18 11:12:06 -04:00
David B. Kinder e58609ad1f doc: remove duplicate 1.6 version menu choice
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-14 12:24:26 -07: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
David B. Kinder b86e90532b doc: fix malformed acrn-issue references
Syntax of acrn-issue role was incorrect in fixed issues section

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-11 17:29:06 -07:00
David B. Kinder 956f1157e2 doc: edit 1.6.1 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-11 08:48:50 -07:00
David B. Kinder 0b18c9bdb4 doc: add 1.6.1 docs version menu choice
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-11 08:48:08 -07:00
fuzhongl 5ed7f889f1 Doc: releasenotes_1.6.1
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-05-11 08:05:07 -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
lirui34 0c36a93cee doc: update industry getting started guide to v1.6.1
Add instruction to launch multiple post launched VMs.

Signed-off-by: lirui34 <ruix.li@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-08 10:06:57 -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
Zide Chen 64e0f498a7 doc: update hvlog kernel parameter descriptions
Signed-off-by: Zide Chen <zide.chen@intel.com>
2020-05-07 10:50:07 -07:00
Yonghua Huang c4ab748cb9 doc: update security advisory for 1.6.1 release
Update mitigations for security vulnerabilities
 for ACRN 1.6.1 release

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-07 10:48:21 -07: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
Geoffroy Van Cutsem 97245363b1 doc: update `acrn-dm` parameters documentation
Update the documentation listing and describing all `acrn-dm` parameters as it
has gone out of sync with the actual implementation. Some parameters are missing
and others are now obsolete.

Tracked-On: #4732
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-06 13:43:35 +08: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
David B. Kinder 58f779a069 doc: update HLD for hv_cpu_virt
Update HLD with @zidechen0 material

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-03 17:15:16 -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
Victor Sun 3f5bfe5511 doc: reference code update for cpu sharing
The VM configuration struct initialization method is slightly changed
recently, so reference code for cpu shaing need to be changed
accordingly.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-05-03 16:34:08 -07:00
Victor Sun 515e478282 doc: remove sdc2 and update industry scenario
Remove SDC2 scenario since usages under SDC2 could be supported by
INDUSTRY scenario which would support up to 7 post-launched VMs.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-05-03 16:34:08 -07:00
David B. Kinder 0bd30017eb doc: update windows as UOS tutorial
Fix consistent spelling of GVT-g and malformed bullet list.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-29 15:38:27 -07:00
fangfang.shen d6a1bd8ca2 doc:update waag gsg after enabling gvt-d and cpu-sharing.
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-04-29 11:43:29 -07:00