Commit Graph

263 Commits

Author SHA1 Message Date
David B. Kinder
707fffac41 doc: update 1.6.1 docs from master
Merge remaining changes from master to the release_1.6 branch for
releasing the 1.6.1 docs

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-11 10:08:30 -07:00
David B. Kinder
ad3d39a274 doc: update release_1.6 with master docs
Another update for the release_1.6 branch with changed docs from the
master branch.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-11 08:06:12 -07:00
David B. Kinder
5632deadc9 doc: update release_1.6 docs with master docs
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-07 14:25:22 +08:00
Zide Chen
ac5facd2d6 doc: update CPU affinity related descriptions
- Changed term from "VCPU affinity" to "CPU affinity"
- changed vcpu_affinity to cpu_affinity_bitmap in vm_config
- fixed some errors

Signed-off-by: Zide Chen <zide.chen@intel.com>
2020-05-03 17:01:16 -07:00
Deb Taylor
fa2bf69720 Doc: Minor grammatical updates to rt_industry.html and building_acrn_in_docker.html
Refer to PRs 4568 and 4559.

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-02 08:59:41 +08:00
lirui34
6540527f54 doc: update industry gsg to v1.6 release
- Update quick setup script to support whl board.
- Change board to WHL NUC.
- Change the Service VM disk to NVMe.
- Update CL version to 32680 and ACRN tags info.
- Update CL and acrn tag versions for waag user vm tutorial.

Signed-off-by: lirui34 <ruix.li@intel.com>
2020-04-01 21:27:01 +08:00
fangfang.shen
9f7eb464d9 Doc: update building acrn in docker for V1.6
One known issue :acrn-issue:`4560` during build ACRN HV.
Please refer to  next section to get Docker Image from Docker Hub.

Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-04-01 21:26:33 +08:00
Deb Taylor
84df88edec Doc: Minor edits to Xenomai page
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-31 14:35:11 +08:00
Deb Taylor
93f1b7e8c6 Doc: Edits to MBA and CAT documentation.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-31 14:34:58 +08:00
Vijay Dhanraj
143f9bbf5b doc: Add MBA documentation and update doc for CAT
This patch updates CAT documentation as well as adds
documentation support for newly added MBA feature.

Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-03-31 14:34:22 +08:00
Tw
d646cc3767 Doc: add instructions for using Xenomai as UOS
Signed-off-by: Tw <wei.tan@intel.com>
2020-03-31 14:33:44 +08:00
David B. Kinder
4c32cbb5db doc: fix docs with windows line endings
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-03-31 14:32:36 +08:00
Deb Taylor
ff646297cc Doc: Edits to workaround note for EFI command line option string issue.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-31 14:32:15 +08:00
fuzhongl
91edc60df9 Doc: add space at the end of efibootmgr bootloader
This is a workaround for the issue in efi-stub: If the EFI option is loaded to a memory range which is not all zero filled,
it's possible the garbage string appended to bootloader name string.
Which could make system can't boot.

Add an extra space to the EFI option to make sure space could be used to detect the end of bootloader name string.

Once the fixing patch is merged, we don't need this extra space.
But to make old ACRN work, we'd like to keep the space here.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Yin Fengwei <fengwei.yin@intel.com>
2020-03-31 14:30:16 +08:00
Deb Taylor
e53c5a743a Doc: Grammatical edits to using_windows_as_uos.rst
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-31 14:26:29 +08:00
ffshen
4dc9a0f09a doc: update waag GSG according to the latest method
Delete Redhad virtio drive, only keep Oracle as reference.
Delete "inject driver into ISO" part, and update to the latest workable
method.
In a word, QA just need maintain one latest workable method in GSG for creating WaaG image.

Signed-off-by: ffshen <fangfang.shen@intel.com>
2020-03-31 14:26:11 +08:00
David B. Kinder
589787282c doc: fix docs with broken links
Fix links in documentation that have moved (e.g.,
clearlinux.org/documentation moved to docs.01.org/clearlinux/latest).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-03-31 14:25:21 +08:00
Deb Taylor
6a386d3fe1 doc: Grammatical updates to SR-IOV virt doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-31 14:24:59 +08:00
Yuan Liu
ef0e51bc41 doc: introduce SR-IOV virtualization
The SR-IOV virtualization document

Tracked-On: #4433
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-03-31 14:24:45 +08:00
lirui34
04cc9eef8b doc: Update build celadon instruction link
Signed-off-by: lirui34 <ruix.li@intel.com>
2020-03-31 14:24:11 +08:00
fuzhongl
cf3544b4ec Doc: VM2 vCPU affinity info update
Update VM2 vCPU affinity info to match with the picture of cpu_sharing

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-02-18 14:28:49 -05:00
Deb Taylor
7d4b2c824f Edits to Ubuntu SOS; changed SOS/UOS to Service VM/User VM
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-02-11 16:47:55 -05:00
Geoffroy Van Cutsem
db6fe1e347 doc: update Grub configuration instructions for Ubuntu (Service VM)
Update the "Using Ubuntu as the Service OS" tutorial to tweak the instructions
pertaining to the Grub bootloader configuration. Specifically, update to reflect
the content of '/etc/default/grub' in Ubuntu 18.04 and also make loading the
Service OS kernel the default.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-02-10 09:46:00 -05:00
Deb Taylor
8896ba25b5 Grammatical edits to Run Kata Containers doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-01-28 10:18:09 -05:00
Geoffroy Van Cutsem
88dfd8d447 doc: update Kata and ACRN tutorial
Update the Kata and ACRN tutorial based on the latest SW components. Many
previous steps are no longer required and have been removed.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-01-28 09:08:37 -05:00
Geoffroy Van Cutsem
dbf9b9334d doc: update the "Using SDC Mode on the NUC" tutorial
Update the "Using SDC Mode on the NUC" tutorial to use ACRN v1.5. The Clear
Linux used in this update is 32080 which is also the first release that includes
a Service VM (linux-iot-lts2018-sos) kernel that supports MACVLAN and MACVTAP,
both of which are need to run Kata Containers on ACRN.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-01-14 10:56:00 -05:00
Deb Taylor
809338a36b Doc: Clarify Post-Launch VM data flow discussion for vuart conf
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-01-14 10:55:02 -05:00
Deb Taylor
7cef407da0 Doc: Fixed spelling error in the acrn_config_tool file.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-01-09 13:19:53 -05:00
Deb Taylor
e8512bf766 Doc: Grammar updates to ACRN Config Tool doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-01-09 10:39:19 -05:00
Victor Sun
545117731a doc: update some xml elements description
Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-01-09 07:43:41 -05:00
Shuang Zheng
9e244b1bb2 doc: update getting start guide about clear linux version and ootb commands
Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
2020-01-09 07:29:19 -05:00
fangfang.shen
5f1fa3cf1b doc: change version info
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-01-09 07:07:13 -05:00
Deb Taylor
e91ecaa7e0 Doc: Grammar update to arcn_ootd.rst.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-01-08 20:30:41 -05:00
fuzhongl
88644ab708 Doc: document update base on release_v1.5
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-01-08 18:39:23 -05:00
Geoffroy Van Cutsem
c59f12da91 doc: fix wrong Docker container image in tutorial
Fix the name of the Docker Container image that is used to build the kernel
for an RTVM (Preempt-RT kernel) when that image was built by the user
him/herself.

Tracked-On: #4322
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-01-05 06:08:42 -05:00
Deb Taylor
5d1a08fc88 Doc: Added missing period in run_kata_containers file.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-12-30 15:14:59 -05:00
lirui34
9071349a19 doc: Update some of the wrong path in acrn configuration tool doc.
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-12-30 14:35:46 -05:00
Geoffroy Van Cutsem
e25a2bf80c doc: add more details to the Kata Containers with ACRN tutorial
* Add more details about Kata Containers and ACRN in the introduction
* Adjust and correct some of the instructions

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-12-30 14:33:45 -05:00
Zide Chen
fc78013fba acrn-config: some cleanup for logical partition mode Linux bootargs
- commit 69152647 ("hv: Use virtual APIC IDs for Pre-launched VMs")
  enables virtual APIC IDs for pre-launched VMs thus xapic_phys is no
  longer needed to force guest xAPIC to work in physical destination mode.

- HVC is not available in logical partition mode and "console=hvc0" should
  be removed from guest Linux bootargs.

Tracked-On: #3854
Signed-off-by: Zide Chen <zide.chen@intel.com>
Acked-by: Victor Sun <victor.sun@intel.com>
2019-12-25 13:46:37 +08:00
Conghui Chen
8f9cda183e DOC: Content edits to CPU Sharing doc
Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2019-12-24 12:55:09 -05:00
Deb Taylor
a408553834 Doc: Content edits to Running Kata containers on a Service VM doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-12-22 22:35:58 -05:00
Deb Taylor
9ee55965f8 Doc: More edits to CPU Sharing doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-12-22 21:56:58 -05:00
Deb Taylor
3e45d5e301 Doc: Content edit to cpu-sharing page
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-12-21 10:04:33 -05:00
lirui34
17f6344ce2 doc: Add tutorial about how to launch kata vm.
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-12-20 07:13:48 -05:00
fenglin.hu
2ceff27069 doc: modify Configuration Tools
Signed-off-by: fenglin.hu <fenglin.hu@intel.com>
2019-12-20 07:12:00 -05:00
Conghui Chen
7edf8ed798 doc: add document for cpu sharing
Add document and usage for cpu sharing.

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2019-12-20 07:11:40 -05:00
Deb Taylor
5f401461e7 Doc: Content edits to Using WaaG VM on ACRN
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-12-16 19:50:42 -05:00
Yuan Liu
6289124e7c doc: add windows 10 activation
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2019-12-16 09:54:56 -05:00
Jian Jun Chen
42b8b6eb6e doc: Update WaaG GSG to use ACRNGT GOP to install Windows
Signed-off-by: Jian Jun Chen <jian.jun.chen@intel.com>
2019-12-16 09:51:35 -05:00
hongliang
9af4a62482 doc: edit using_ubuntu_as_sos.rst adjust to v1.4
Signed-off-by: hongliang <hongliangx.ye@intel.com>
2019-11-26 17:19:50 -08:00