Prologue</button><div class="collapse show" id=section-prologue><ul class="btn-toggle-nav list-unstyled fw-normal pb-1 small"><li><a class="docs-link rounded active" href=https://www.cloudhypervisor.org/docs/prologue/introduction/>Introduction</a></li><li><a class="docs-link rounded" href=https://www.cloudhypervisor.org/docs/prologue/quick-start/>Quick Start</a></li><li><a class="docs-link rounded" href=https://www.cloudhypervisor.org/docs/prologue/commands/>Commands</a></li></ul></div></li></ul></nav></div><nav class="docs-toc d-none d-xl-block col-xl-3" aria-label="Secondary navigation"><div class=page-links><h3>On this page</h3><nav id=TableOfContents><ul><li><a href=#quick-start>Quick Start</a></li><li><a href=#go-further>Go further</a><ul><li><a href=#user-documentation>User documentation</a></li><li><a href=#developer-documentation>Developer documentation</a></li></ul></li><li><a href=#contributing>Contributing</a></li><li><a href=#help>Help</a></li></ul></nav></div></nav><main class="docs-content col-lg-11 col-xl-9"><h1>Introduction</h1><p class=lead>Cloud Hypervisor is an open source Virtual Machine Monitor (VMM) implemented in Rust that focuses on running modern, cloud workloads, with minimal hardware emulation.</p><nav class=d-xl-none aria-label="Quaternary navigation"><div class=page-links><h3>On this page</h3><nav id=TableOfContents><ul><li><a href=#quick-start>Quick Start</a></li><li><a href=#go-further>Go further</a><ul><li><a href=#user-documentation>User documentation</a></li><li><a href=#developer-documentation>Developer documentation</a></li></ul></li><li><a href=#contributing>Contributing</a></li><li><a href=#help>Help</a></li></ul></nav></div></nav><h2 id=quick-start>Quick Start <a href=#quick-start class=anchor aria-hidden=true>#</a></h2><p>See the <a href=https://www.cloudhypervisor.org/docs/prologue/quick-start/>Quick Start →</a> for a single page guide to getting started with Cloud Hypevisor.</p><h2 id=go-further>Go further <a href=#go-further class=anchor aria-hidden=true>#</a></h2><p>Currently the majority of the documentation is in the source tree but a user guide, which will be hosted on this website is planned.</p><h3 id=user-documentation>User documentation <a href=#user-documentation class=anchor aria-hidden=true>#</a></h3><p>Here are some documents related to particular features and functionality that a user of Cloud Hypervisor might be interested in:</p><ul><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/api.md>HTTP API</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/cpu.md>Virtual CPU configuration</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/fs.md>Using virtio-fs</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/hotplug.md>How to hotplug devices</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/intel_sgx.md>How to use Intel SGX</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/iommu.md>vIOMMU configuration</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/io_throttling.md>I/O throttling for network and block devices</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/live_migration.md>Live migration</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/macvtap-bridge.md>Using a MACvTAP bridge to place a VM on the host network</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/memory.md>Advanced memory configuration</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/snapshot_restore.md>Snapshot & Restore of a VM</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/uefi.md>Building a UEFI firmware for use with Cloud Hypervisor</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/vfio.md>Using VFIO to passthrough PCI devices</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/vfio-user.md>Emulated NVMe controller via vfio-user</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/virtiofs-root.md>Using virtio-fs as as a root filesystem</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/windows.md>Running and debugging Windows guests</a></li></ul><h3 id=developer-documentation>Developer documentation <a href=#developer-documentation class=anchor aria-hidden=true>#</a></h3><p>These documents are primarily for developers who are working on the project:</p><ul><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/custom-image.md>Updating the custom image</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/debug-port.md>Debug port logging for performance testing</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/logging.md>Correct use of logging</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/profiling.md>How to profile Cloud Hypervisor</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/seccomp.md>Seccomp filter debugging</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/vhost-user-blk-testing.md>Testing vhost-user-block</a></li><li><a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/vhost-user-net-testing.md>Testing vhost-user-net</a></li></ul><h2 id=contributing>Contributing <a href=#contributing class=anchor aria-hidden=true>#</a></h2><p>See the <a href=https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/CONTRIBUTING.md>CONTRIBUTING file</a> in the source tree for details of how to contribute.</p><h2 id=help>Help <a href=#help class=anchor aria-hidden=true>#</a></h2><p>Need help with Cloud Hypervisor? Open a <a href=https://github.com/cloud-hypervisor/cloud-hypervisor/discussions>discussion thread on Github</a> or ask in <a href=https://join.slack.com/t/cloud-hypervisor/shared_invite/enQtNjY3MTE3MDkwNDQ4LWQ1MTA1ZDVmODkwMWQ1MTRhYzk4ZGNlN2UwNTI3ZmFlODU0OTcwOWZjMTkwZDExYWE3YjFmNzgzY2FmNDAyMjI>our Slack</a>.</p><div class="docs-navigation d-flex justify-content-between"><a class=ms-auto href=https://www.cloudhypervisor.org/docs/prologue/quick-start/><div class="card my-1"><div class="card-body py-2">Quick Start →</div></div></a></div></main></div></div></div><footer class="footer text-muted"><div class=container-xxl><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Copyright © 2021 Cloud Hypervisor a Series of LF Projects, LLC. For website terms of use, trademark policy, privacy policy and other project policies please see https://lfprojects.org/policies. Rendered with <a href=https://gohugo.io/>Hugo</a>, and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://www.cloudhypervisor.org/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script>
0 commit comments