Commit Graph

997 Commits

Author SHA1 Message Date
David B. Kinder
d8ee2f3303 doc: update release_2.1 with new docs
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 17:44:26 -07:00
zhanqi
288efd31b4 create acrn hypervisor/kernel deb packaging
Tracked-On: #5022

Signed-off-by: zhanqi <sherry.qi.zhang@intel.com>
2020-07-20 11:44:07 +08:00
David B. Kinder
c455085f6d doc: update intro link to project roadmap
Instead of linking to a specific doc on projectacrn.org, update to just
link to the area on projectacrn.org/#resources where the roadmap doc can
be found.  Also remove mention of 2020 to keep it generic so it won't
need updating in 2021.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-13 15:40:34 -07:00
David B. Kinder
2fd1a79ef0 doc: keep doxygen group descriptions in doc output
Propagated fix from other doxygen/breathe project to keep the
description found in the doxygen comments for the group being displayed
(in case there actually is a nice description given).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-10 13:50:58 -07:00
Mostafa Naeem
e43b6c7854 doc: Update Inter-VM Communication with Security Hardening Guidelines
ACRN 2.0 introduced Inter-VM communication feature by enabling the ivshmem v1.0 protocol/channel to communication
between VMs. To support the community's application Security Development Lifecycle (SDL), we provide a security hardening
guideline with some pointers to consider when using this channel by userspace application in case of additional security
requirments for Confidentiality, Integrity, or Authenticity.

Signed-off-by: Mostafa Naeem <mostafa.elsaid@intel.com>
2020-07-10 13:50:24 -07:00
David B. Kinder
aa45937860 doc: Update contribution guide instructions
While changes to documentation can be submitted directly as PRs, changes
to code must be first submitted for approval to the developer mailing
list.  Update the contribution guidelines to talk about this.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-08 10:52:57 -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
055fe2c615 doc: update Ubuntu GSG with 2.0 fixes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 09:50:57 -07:00
David B. Kinder
7dd4061bcc doc: add 2.0 to doc version selector
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 09:32:28 -07:00
fuzhongl
eabb512ded DOC: v2.0 release notes
Add fixed issues and known issues in release note.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 08:43:21 -07:00
fangfang.shen
c2187f20c2 doc: update Ubuntu GSG for ACRN V2.0.
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 08:30:35 -07:00
Yuan Liu
215829fd7e doc: refine ivshmem architecture diagram
refine the dm-land and hypervisor-land flows

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-06-22 11:30:21 -07:00
David B. Kinder
b82e6146c4 doc: more release notes 2.0 edits
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-22 10:14:09 -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
9ff0d30ad6 doc: fix style for lists in note
Fix CSS style for lists inside a note.  Previously the first list item
would overlap in the note heading box.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-18 13:33:01 -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
David B. Kinder
380cd7f33e doc: update 2.0 release notes
Updates from reviewer comments included

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-18 11:02:37 -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
137f7d67e7 doc: v2.0 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-17 20:34:22 -07:00
David B. Kinder
86eb68a1e7 doc: open external links in new tab
As a UX improvement, use a separate tab when opening links to external
sites (use the same tab for internal links).  Also, use rel=noopener
attribute to improve security when linking to external sites.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-17 15:58:49 -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
Geoffroy Van Cutsem
c84f3f9a97 doc: update the summary table for all ACRN scenario
Update the table summarizing all ACRN scenario that are defined. The SDC
also offers the opportunity to run a Kata Containers VM and that was missing
from the description.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-06-16 11:35:02 -07:00
David B. Kinder
13e8e3c7f2 doc: adjust search results to bias certain docs
Improve usability of search results to promote tutorials and developer
guides, and demote API and KConfig material, with release notes at the
end.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-15 12:30:36 -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
315b7f3c00 Doc: Grammatical edits to Shared mem based inter-VM comm doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-06-12 16:23:27 -04:00
Deb Taylor
e707cdc768 Doc: Edits to What is ACRN into doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-06-12 16:09:18 -04: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
Geoffroy Van Cutsem
f671f646a4 doc: Update the GSG for the Industrial scenario with Ubuntu
Update the "Getting Started Guide for ACRN Industry Scenario with Ubuntu Service
VM" document. Specifically:
* Fix some code sequences that were incorrect (wrong file names/paths, etc.)
* Broke down some long lines to improve readibility
* Add some text/notes at places to better explain the process

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-12 11:55:00 -07:00
Geoffroy Van Cutsem
5f28b90dad doc: update "What is ACRN" introduction
Refresh and update the "What is ACRN" document to reflect the latest changes.
Most notably, the scenario definitions have changed.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-06-12 13:48:25 -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
5d08f2518f doc: update the 'ivshmem' HLD
Update the 'ivshmem' document to clarify the existence of two similar
mechanisms to expose this device to User VMs. One is implemented in the ACRN
Device Model and another (future) is implemented in the hypervisor.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-06-12 13:45:53 -04:00
David B. Kinder
60d16feda6 doc: update ivshmem examples
Update edits from PR #4921

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-10 11:44:22 -04:00
Yuan Liu
279a3995b6 doc: add inter-vm communication example
Add the example for two post-launched VMs communication

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-06-09 14:37:59 -07: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
David B. Kinder
63d7bec3d1 doc: more updates to ivshmem image and doc
Update image and doc with additional review comments

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-08 20:38:15 -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
e94922dfdc doc: update ivshmem image with corrections
Fixed spelling errors in the include image

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-07 19:17:34 -07:00
David B. Kinder
686419ce7d doc: fix columns issue with 404 page display
A previous error (now fixed) in how the rst-columns CSS was written,
caused the default rst-columns to use 3 columns, when before (because of
the error) it being ignored.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-05 16:44:15 -07:00
David B. Kinder
3d4cc0bff5 doc: edit ivshmem hld doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-05 16:08:08 -07:00
Yuan Liu
19c50a1162 doc: add shared memory based inter-vm communication introduction
The shared memory based inter-vm communication can support high
performance communication between VMs.

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-06-05 14:32:33 -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
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