Muminul Islam
4cea713adf
docs: Add documentations for MSHV and related features
...
This patch adds brief overview and relation of mshv,
igvm, and sev-snp features.
Signed-off-by: Muminul Islam <muislam@microsoft.com>
2023-11-10 11:30:40 -08:00
Ravi kumar Veeramally
fa22cb0be5
docs: update command line options to use clap
...
Reverts commit a0922930b1
and update to latest changes.
Signed-off-by: Ravi kumar Veeramally <ravikumar.veeramally@intel.com>
2023-10-20 11:44:28 -07:00
Wei Liu
6113483363
docs: add notes on collecting coverage data from in-tree tests
...
Signed-off-by: Wei Liu <liuwe@microsoft.com>
2023-10-20 10:35:13 -07:00
Wei Liu
fc6ff07fd7
docs: add a document for collecting coverage data
...
Signed-off-by: Wei Liu <liuwe@microsoft.com>
2023-10-19 13:07:54 -07:00
Yi Wang
83b1a30f29
docs: fix the description of host/guest in vsock
...
In Connecting from Host to Guest section, the host/guest are misused,
this patch fix that.
Signed-off-by: Yi Wang <foxywang@tencent.com>
2023-10-19 09:39:17 -07:00
Thomas Barrett
3029fbeafd
vmm: Allow assignment of PCI segments to NUMA node
...
Signed-off-by: Thomas Barrett <tbarrett@crusoeenergy.com>
2023-10-18 11:18:15 -07:00
Dario Nieuwenhuis
beeb2f5136
docs/balloon: fix typos
...
Signed-off-by: Dario Nieuwenhuis <dirbaio@dirbaio.net>
2023-09-23 09:37:32 +01:00
Ruslan Mstoi
e151483f70
docs: intel_tdx: add info about dependencies
...
Required Debian packages are the same as described in uefi.md
Signed-off-by: Ruslan Mstoi <ruslan.mstoi@intel.com>
2023-09-11 16:39:16 +01:00
Ruslan Mstoi
b904d666b0
docs: intel_tdx: fix python not found error
...
Fix make error:
$ make -C BaseTools -j `nproc`
/bin/sh: line 1: python: command not found
make[1]: *** [GNUmakefile:11: test] Error 127
Signed-off-by: Ruslan Mstoi <ruslan.mstoi@intel.com>
2023-09-11 16:39:16 +01:00
Ruslan Mstoi
6d395c51db
docs: intel_tdx: add jobs argument to make
...
This could speed up the build
Signed-off-by: Ruslan Mstoi <ruslan.mstoi@intel.com>
2023-09-11 13:27:40 +01:00
Philipp Schuster
7bf0cc1ed5
misc: Fix various spelling errors using typos
...
This fixes all typos found by the typos utility with respect to the config file.
Signed-off-by: Philipp Schuster <philipp.schuster@cyberus-technology.de>
2023-09-09 10:46:21 +01:00
Jinank Jain
70074ddf9f
docs: Add documentation for AMD SEV-SNP
...
Creating some brief documentation for SEV-SNP, summarizing the links on
where to find more information about SEV-SNP, as well as how to build
and run Cloud Hypervisor on it.
This document is a work in progress and will be updated in future PRs
as we add support for it.
Signed-off-by: Jinank Jain <jinankjain@microsoft.com>
2023-09-07 12:52:27 +01:00
Omer Faruk Bayram
cc5dd8c297
docs: api: document newly added event signal to the D-Bus API
...
Signed-off-by: Omer Faruk Bayram <omer.faruk@sartura.hr>
2023-08-28 17:01:03 -07:00
Omer Faruk Bayram
83914d80a2
docs: api: document the D-Bus API
...
Signed-off-by: Omer Faruk Bayram <omer.faruk@sartura.hr>
2023-06-06 10:18:26 -07:00
Rafael Mendonca
f8415debe9
docs: Fix broken link to macvtap doc in custom-image.md
...
We get a "404 - page not found" when clicking on this link on github.
Signed-off-by: Rafael Mendonca <rafaelmendsr@gmail.com>
2023-06-02 14:57:24 -07:00
Bo Chen
2b4f60e57b
docs: Remove directory support from MemoryZoneConfig::file
...
Signed-off-by: Bo Chen <chen.bo@intel.com>
2023-04-04 06:49:18 -07:00
Omer Faruk Bayram
e7d52fc736
docs: api: document receive-migration
and send-migration
...
Signed-off-by: Omer Faruk Bayram <omer.faruk@sartura.hr>
2023-03-31 10:02:34 -07:00
Omer Faruk Bayram
36cf46e381
docs: document that vmcoredump
is conditionally compiled
...
Fixes #5311 .
Signed-off-by: Omer Faruk Bayram <omer.faruk@sartura.hr>
2023-03-28 11:16:13 +01:00
Ravi kumar Veeramally
44452cbe22
doc: Fix broken link for micro_http website
...
Signed-off-by: Ravi kumar Veeramally <ravikumar.veeramally@intel.com>
2023-03-09 09:58:46 -08:00
Bo Chen
3377e0e983
docs: hotplug: Fix link to booting with uefi on aarch64
...
Signed-off-by: Bo Chen <chen.bo@intel.com>
2023-02-12 14:40:04 +08:00
Bo Chen
bc59ca72f3
docs: Update the intel_tdx documentation
...
Updates include:
- Add references to 'TDX Tools'
- Expand instructions on buidling and using TDShim
- Add version information of guest/host kernel, TDVF, TDShim being tested
Signed-off-by: Bo Chen <chen.bo@intel.com>
2023-02-07 06:30:38 -08:00
Ravi kumar Veeramally
aaf67c9ae4
doc: Add musl-tools to instructions for build
...
As a first time user of cloud-hypervisor and Rust environment
you get build errors with out this.
Signed-off-by: Ravi kumar Veeramally <ravikumar.veeramally@intel.com>
2023-01-26 08:09:46 -08:00
Bo Chen
ec45daac19
docs: Use the TDVF firmware from the edk2 repository
...
Signed-off-by: Bo Chen <chen.bo@intel.com>
2023-01-23 10:25:27 +01:00
Rob Bradford
a86edd3032
tests: Add tpm2-tools to custom jammy image
...
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2023-01-19 19:19:52 +00:00
Rob Bradford
dab9f1cf30
docs: Add instructions for heap profiling
...
Fixes : #5074
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2023-01-17 14:02:01 +00:00
Rob Bradford
e2886a4b1f
docs: Update instructions to point to new profiling target
...
This removes the need for the user to manually change the Cargo.toml
file for profiling.
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2023-01-17 14:02:01 +00:00
Wei Liu
a0922930b1
docs: update command line options
...
Signed-off-by: Wei Liu <liuwe@microsoft.com>
2023-01-16 16:39:03 +00:00
Rob Bradford
c89b8e061f
Revert "vmm: Deprecate MemoryZoneConfig::file"
...
This reverts commit 9fb0274479
.
A user was identified of this functionality.
See: #4837
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2023-01-10 10:31:18 +00:00
Claudio Fontana
683d116416
docs: update UEFI.md to reference upstream tianocore EDK2 repository
...
after testing the build briefly, it seems upstream tianocore EDK2 works fine,
no need for the separate cloud-hypervisor edk2 repo.
Signed-off-by: Claudio Fontana <claudio.fontana@gmail.com>
2022-12-13 18:16:34 +01:00
Henry Wang
b93d50582d
docs: Consolidate AArch64 guest booting doc into README
...
Take the opportunity to fix a bug in the `Booting the guest VM` doc
in README.
Signed-off-by: Henry Wang <Henry.Wang@arm.com>
2022-12-13 13:38:11 +00:00
Henry Wang
de4cd49c6d
docs: Consolidate AArch64 kernel building doc into README
...
Signed-off-by: Henry Wang <Henry.Wang@arm.com>
2022-12-13 13:38:11 +00:00
Henry Wang
709545920e
docs: Consolidate AArch64 cloud-img related doc into README
...
Signed-off-by: Henry Wang <Henry.Wang@arm.com>
2022-12-13 13:38:11 +00:00
Henry Wang
2b11966faa
docs: Consolidate AArch64 UEFI doc into uefi.md
...
Signed-off-by: Henry Wang <Henry.Wang@arm.com>
2022-12-13 13:38:11 +00:00
Henry Wang
6835dfa5e9
docs: Consolidate building on AArch64 to building.md
...
Signed-off-by: Henry Wang <Henry.Wang@arm.com>
2022-12-13 13:38:11 +00:00
Henry Wang
d15e1f1a13
docs: Move AArch64 hardware requirements to README
...
Also drop the SWAP enabling requirements for AArch64 because this
is an AArch64 specific issue.
Signed-off-by: Henry Wang <Henry.Wang@arm.com>
2022-12-13 13:38:11 +00:00
Rob Bradford
9fb0274479
vmm: Deprecate MemoryZoneConfig::file
...
Remove from the documentation and API definition but continue support
using the field (with a deprecation warning.)
See: #4837
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-12-12 16:44:04 +00:00
Yuji Hagiwara
47a7ebe434
docs: Fix a typo on the doc for tpm
...
swtpm accepts --tpmstate option
Signed-off-by: Yuji Hagiwara <yuuzi41@gmail.com>
2022-11-27 18:55:07 +00:00
Sebastien Boeuf
9f7ccb34cd
docs: Provide documentation for creating custom image for VFIO CI
...
Extend the existing `custom-image.md` document with a new section on how
to create a custom image that contains NVIDIA drivers that are required
for our VFIO baremetal CI.
Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
2022-11-25 13:39:25 +01:00
Rob Bradford
1e87a409c7
docs: Add cpuid to custom disk image instructions
...
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-11-18 18:31:55 +00:00
Praveen K Paladugu
324c5deb37
docs: Add doc for using and testing tpm device
...
Signed-off-by: Praveen K Paladugu <prapal@linux.microsoft.com>
2022-11-15 16:42:21 +00:00
Rob Bradford
2c94773bdc
docs: seccomp: Enhance strace command to print thread name
...
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-11-11 16:47:24 +00:00
Rob Bradford
04d034a0bc
docs: Update memory.md for THP
...
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-11-09 16:51:21 +00:00
Rob Bradford
6722c303b0
docs: Fix broken link in windows.md
...
Fixes : #4840
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-11-02 11:40:44 +00:00
Rob Bradford
aad4dc3b6b
docs: Update memory.md to indicated that hugepages overrides shared
...
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-10-31 22:28:29 +00:00
Rob Bradford
ffc222b26e
docs: Modernise README
...
Refresh our README in a consistent style and update it to reflect:
* A recommendation to use binaries
* Clarify our relationship with other Rust based VMMs/Rust-VMM project
* Ensure instructions result in a usable image (cloud-init)
* Simplify script instructions
* Move compilation details elsewhere
* Add Fedora 36 image details
* Point to CLOUDHV as well as Rust Hypervisor Firmware
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-10-14 12:04:06 +01:00
Rob Bradford
06eb82d239
build: Consolidate "gdb" build feature into "guest_debug"
...
This simplifies the CI process but also logical with the existing
functionality under "guest_debug" (dumping guest memory).
Fixes : #4679
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-09-27 14:30:57 +01:00
Rob Bradford
e53419ecfc
docs: Add documentation of tracing infrastructure
...
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-09-22 18:09:31 +01:00
Anatol Belski
1d3bb63ec8
doc: Add VSOCK doc page
...
Signed-off-by: Anatol Belski <anbelski@linux.microsoft.com>
Co-authored-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
2022-09-15 09:07:21 +01:00
Sebastien Boeuf
3793ffe888
vmm: config: Move TDX to rely on PayloadConfig
...
Removing the option --tdx to specify that we want to run a TD VM. Rely
on --platform option by adding the "tdx" boolean parameter. This is the
new way for enabling TDX with Cloud Hypervisor.
Along with this change, the way to retrieve the firmware path has been
updated to rely on the recently introduced PayloadConfig structure.
Fixes #4556
Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
2022-09-05 12:14:59 +01:00
Rob Bradford
072af95609
docs: api.md: Fix table markdown syntax
...
Signed-off-by: Rob Bradford <robert.bradford@intel.com>
2022-08-10 22:20:07 +01:00