microsoft/openvmm

Public

mirrored fromhttps://github.com/microsoft/openvmmAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
191dd827d047f7a93c67878632576e56ce03c041

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

Guide/src/SUMMARY.md

148lines · modecode

1# Summary
2
3[Introduction](./index.md)
4
5# Getting Started
6
7- [OpenVMM](./user_guide/openvmm.md)
8 - [Running OpenVMM](./user_guide/openvmm/run.md)
9 - [Alpine Linux](./user_guide/openvmm/alpine.md)
10 - [VM Configurations](./user_guide/openvmm/vm_configurations.md)
11 - [VFIO Device Assignment](./user_guide/openvmm/vfio.md)
12 - [Troubleshooting](./user_guide/openvmm/troubleshooting.md)
13 - [Snapshots](./user_guide/openvmm/snapshots.md)
14 - [Next Steps](./user_guide/openvmm/next_steps.md)
15- [OpenHCL](./user_guide/openhcl.md)
16 - [Running OpenHCL](./user_guide/openhcl/run.md)
17 - [On Windows - Hyper-V](./user_guide/openhcl/run/hyperv.md)
18 - [On Windows - OpenVMM](./user_guide/openhcl/run/openvmm.md)
19 - [On Linux](./user_guide/openhcl/run/openvmm_linux.md)
20 - [Troubleshooting](./user_guide/openhcl/troubleshooting.md)
21 - [Next Steps](./user_guide/openhcl/next_steps.md)
22
23# Developer Guide
24
25- [Getting Started](./dev_guide/getting_started.md)
26 - [On Linux / WSL2](./dev_guide/getting_started/linux.md)
27 - [On Windows](./dev_guide/getting_started/windows.md)
28 - [Via Codespaces / Dev Container](./dev_guide/getting_started/devcontainer.md)
29 - [Building OpenVMM](./dev_guide/getting_started/build_openvmm.md)
30 - [Building OpenHCL](./dev_guide/getting_started/build_openhcl.md)
31 - [Building a Custom Kernel](./dev_guide/getting_started/build_ohcl_kernel.md)
32 - [Suggested Dev Environment](./dev_guide/getting_started/suggested_dev_env.md)
33 - [Cross Compiling for Windows](./dev_guide/getting_started/cross_compile.md)
34 - [Running from WSL2](./dev_guide/getting_started/running_from_wsl.md)
35- [Testing](./dev_guide/tests.md)
36 - [Unit Tests](./dev_guide/tests/unit.md)
37 - [VMM Tests](./dev_guide/tests/vmm.md)
38 - [Azure-hosted Test Images](./dev_guide/tests/vmm/azure_images.md)
39 - [Performance Tests (burette)](./dev_guide/tests/perf.md)
40 - [Fuzzing](./dev_guide/tests/fuzzing.md)
41 - [Running Fuzzers](./dev_guide/tests/fuzzing/running.md)
42 - [Writing Fuzzers](./dev_guide/tests/fuzzing/writing.md)
43- [Developer Tools / Utilities](./dev_guide/dev_tools.md)
44 - [`flowey`](./dev_guide/dev_tools/flowey.md)
45 - [`Flowey Fundamentals`](./dev_guide/dev_tools/flowey/flowey_fundamentals.md)
46 - [`Steps`](./dev_guide/dev_tools/flowey/steps.md)
47 - [`Variables`](./dev_guide/dev_tools/flowey/variables.md)
48 - [`Nodes`](./dev_guide/dev_tools/flowey/nodes.md)
49 - [`Artifacts`](./dev_guide/dev_tools/flowey/artifacts.md)
50 - [`Pipelines`](./dev_guide/dev_tools/flowey/pipelines.md)
51 - [`Nix`](./dev_guide/dev_tools/flowey/nix.md)
52 - [`cargo xtask`](./dev_guide/dev_tools/xtask.md)
53 - [`cargo xflowey`](./dev_guide/dev_tools/xflowey.md)
54 - [VmgsTool](./dev_guide/dev_tools/vmgstool.md)
55 - [update-rootfs.py]()
56 - [igvmfilegen]()
57 - [guest_test_uefi](./dev_guide/dev_tools/guest_test_uefi.md)
58 - [hypestv](./dev_guide/dev_tools/hypestv.md)
59- [Contributing](./dev_guide/contrib.md)
60 - [Coding Conventions](./dev_guide/contrib/code.md)
61 - [Save State](./dev_guide/contrib/save-state.md)
62 - [Snapshot Format](./dev_guide/snapshot_format.md)
63 - [Releases & Code Flow](./dev_guide/contrib/release.md)
64 - [Submitting Changes](./dev_guide/contrib/pr.md)
65 - [Code Review Process](./dev_guide/contrib/code_review.md)
66 - [Guide Updates](./dev_guide/contrib/guide.md)
67 - [Style Guide](./dev_guide/contrib/style_guide.md)
68
69# Reference
70
71- [OpenVMM Features](./reference/openvmm.md)
72 - [Configuration and Management](./reference/openvmm/management.md)
73 - [CLI](./reference/openvmm/management/cli.md)
74 - [Interactive Console](./reference/openvmm/management/interactive_console.md)
75 - [gRPC / ttrpc](./reference/openvmm/management/grpc.md)
76 - [Graphical Console](./reference/openvmm/graphical_console.md)
77 - [Logging](./reference/openvmm/logging.md)
78- [OpenHCL Features](./reference/openhcl.md)
79 - [Dynamic Configuration]()
80 - [Diagnostics](./reference/openhcl/diag.md)
81 - [Preface: CVM restrictions](./reference/openhcl/diag/cvm_restrictions.md)
82 - [Intro to ohcldiag-dev](./reference/openhcl/diag/ohcldiag_dev.md)
83 - [Network packet capture (PCAP)](./reference/openhcl/diag/ohcldiag_dev/pcap.md)
84 - [Performance analysis](./reference/openhcl/diag/ohcldiag_dev/perf.md)
85 - [Tracing](./reference/openhcl/diag/tracing.md)
86 - [Debugging](./reference/openhcl/debugging.md)
87- [Developer Features]()
88 - [Hardware Debugging (gdbstub)](./reference/dev_feats/gdbstub.md)
89 - [Kernel Debugging (KDNET)](./reference/dev_feats/kdnet.md)
90- [Firmware and Boot Modes](./reference/devices/firmware/overview.md)
91 - [UEFI: mu_msvm](./reference/devices/firmware/mu_msvm_uefi.md)
92 - [BIOS: Hyper-V PCAT BIOS](./reference/devices/firmware/pcat_bios.md)
93 - [Linux Direct](./reference/devices/firmware/linux_direct.md)
94- [Devices]()
95 - [Virtio]()
96 - [virtio-fs]()
97 - [virtio-9p]()
98 - [virtio-net]()
99 - [virtio-pmem]()
100 - [VMBus]()
101 - [storvsp](./reference/devices/vmbus/storvsp.md)
102 - [Channels & Subchannels](./reference/devices/vmbus/storvsp_channels.md)
103 - [netvsp]()
104 - [vpci]()
105 - [serial]()
106 - [framebuffer]()
107 - [input]()
108 - [Emulated]()
109 - [vTPM]()
110 - [NVMe]()
111 - [Overview](./reference/emulated/NVMe/overview.md)
112 - [Doorbells](./reference/emulated/NVMe/doorbells.md)
113 - [Serial]()
114 - [Legacy x86]()
115 - [i440BX + PIIX4 chipset]()
116 - [IDE HDD/Optical](./reference/emulated/legacy_x86/ide.md)
117 - [Floppy](./reference/emulated/legacy_x86/floppy.md)
118 - [PCI]()
119 - [VGA]()
120 - [PCIe]()
121 - [Overview](./reference/emulated/pcie/overview.md)
122- [Device Backends]()
123 - [Serial]()
124 - [Graphics and Input]()
125 - [Storage](./reference/backends/storage.md)
126 - [Networking](./reference/backends/networking.md)
127 - [Consomme](./reference/backends/consomme.md)
128- [Architecture](./reference/architecture.md)
129 - [OpenVMM Architecture](./reference/architecture/openvmm.md)
130 - [mesh](./reference/architecture/openvmm/mesh.md)
131 - [Using mesh](./reference/architecture/openvmm/mesh/usage.md)
132 - [How mesh works](./reference/architecture/openvmm/mesh/internals.md)
133 - [inspect]()
134 - [OpenHCL Architecture](./reference/architecture/openhcl.md)
135 - [Processes and Components](./reference/architecture/openhcl/processes.md)
136 - [VMBus Relay and Device Interception](./reference/architecture/openhcl/vmbus.md)
137 - [Storage Translation](./reference/architecture/openhcl/storage_translation.md)
138 - [Storage Configuration Model](./reference/architecture/openhcl/storage_configuration.md)
139 - [Boot Flow](./reference/architecture/openhcl/boot.md)
140 - [Sidecar](./reference/architecture/openhcl/sidecar.md)
141 - [CPU Scheduling](./reference/architecture/openhcl/cpu_scheduling.md)
142 - [IGVM](./reference/architecture/openhcl/igvm.md)
143 - [Device Architecture](./reference/architecture/devices.md)
144 - [Storage Pipeline](./reference/architecture/devices/storage.md)
145
146---
147
148[OpenVMM Rust Crate API Docs](./rustdoc.md)
149