crosvm/docs/book/src/introduction.md
Junichi Uekawa 7225ebc077 crosvm: Sprinkle notes on API search.
It's not obvious it's possible to search API docs, it's one of the
things I would use the most often if it's reachable.

BUG=None
TEST=read it.

Change-Id: I29df6ae4df3eb667f17e22d0afc00aee80912187
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3267906
Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
2021-11-08 07:21:20 +00:00

26 lines
1.2 KiB
Markdown

# Introduction
The crosvm project is a hosted (a.k.a.
[type-2](https://en.wikipedia.org/wiki/Hypervisor#Classification)) virtual
machine monitor.
crosvm runs untrusted operating systems along with virtualized devices.
Initially intended to be used with KVM and Linux, crosvm supports multiple kinds
of hypervisors. crosvm is focussed on safety within the programming language and
a sandbox around the virtual devices to protect the host from attack in case of
exploits in crosvm itself.
Other programs similar to crosvm are QEMU and VirtualBox. An operating system,
made of a root file system image and a kernel binary, are given as input to
crosvm and then crosvm will run the operating system using the platform's
hypervisor.
* [Source code](https://chromium.googlesource.com/chromiumos/platform/crosvm/)
* [GitHub mirror](https://github.com/google/crosvm)
* [API documentation](https://google.github.io/crosvm/doc/crosvm/), useful
for searching API.
* Files for this book are under
[/docs/](https://chromium.googlesource.com/chromiumos/platform/crosvm/+/HEAD/docs/).
* [Issue tracker](https://bugs.chromium.org/p/chromium/issues/list?q=component:OS%3ESystems%3EContainers)
![logo](./logo.svg)