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>
This commit is contained in:
Henry Wang 2022-12-07 23:12:33 -05:00 committed by Rob Bradford
parent 8ab15b9a98
commit d15e1f1a13
2 changed files with 6 additions and 20 deletions

View File

@ -69,10 +69,12 @@ Cloud Hypervisor supports `64-bit Linux` and Windows 10/Windows Server 2019.
# 2. Getting Started # 2. Getting Started
The following sections describe how to build and run Cloud Hypervisor on the The following sections describe how to build and run Cloud Hypervisor.
`x86-64` platform. For getting started on the `AArch64` platform, please refer
to the ## Prerequisites for AArch64
[AArch64 documentation](docs/arm64.md).
- AArch64 servers (recommended) or development boards equipped with the GICv3
interrupt controller.
## Host OS ## Host OS

View File

@ -7,22 +7,6 @@ booting and direct-kernel booting. The document covers both methods.
All the steps are based on Ubuntu. We use the Ubuntu cloud image for guest VM All the steps are based on Ubuntu. We use the Ubuntu cloud image for guest VM
disk. disk.
## Hardware requirements
- AArch64 servers (recommended) or development boards equipped with the GICv3
interrupt controller.
- On development boards that have constrained RAM resources, if the creation of
a VM consumes a large portion of the free memory on the host, it may be required
to enable swap. For example, this was required on a board with 3 GB of RAM
booting a 2 GB VM at a point in time when 2.8 GB were free. Without enabling
swap the `cloud-hypervisor` process was terminated by the OOM killer. In this
situation memory was allocated for the virtual machine using memfd while the
page cache was filled, leading to a situation where the kernel could not even
drop caches. Making a small section of swap available (observably, 1 to 15 MB),
this situation can be resolved and the resulting memory footprint of
`cloud-hypervisor` is as expected.
## Getting started ## Getting started
We create a folder to build and run Cloud Hypervisor at `$HOME/cloud-hypervisor` We create a folder to build and run Cloud Hypervisor at `$HOME/cloud-hypervisor`