Bite-sized, practical tutorials for deploying and managing virtualization workloads on Red Hat OpenShift Virtualization. This cookbook complements official training and documentation with hands-on guides, tested YAML manifests, and troubleshooting tips for partner and customer engineers.
| Module | Topics |
|---|---|
| Getting Started | Prerequisites, operator installation, creating VMs, virtctl CLI, VM lifecycle states, default storage class |
| Storage | LVM Operator, storage classes, HostPath provisioner, multi-disk configuration, troubleshooting |
| Networking | UDN primary networks, localnet, VLAN, Linux bridges, SR-IOV, static IPs, ingress routes, troubleshooting |
| VM Configuration | Templates, node placement, hotplug volumes/interfaces, remote access (Linux/Windows), internal DNS, VirtIO drivers |
| Performance | CPU pinning, NUMA/hugepages, real-time VMs, resource limits and QoS |
| VM Lifecycle | Golden images, boot order/sources, snapshots, cloning, qcow2 import |
| API | Component overview |
| Appendix | Glossary and reference material |
To follow the tutorials you need:
- An OpenShift 4.18+ cluster with the OpenShift Virtualization operator installed
- The
ocCLI authenticated to the cluster - The
virtctlCLI (installation guide) - Basic familiarity with Kubernetes concepts (pods, namespaces, services)
Some tutorials have additional requirements (specific storage backends, network configurations, or multiple nodes). Each tutorial lists its own prerequisites at the top.
| Component | Version |
|---|---|
| OpenShift Container Platform | 4.18+ |
| OpenShift Virtualization Operator | 4.18+ |
| KubeVirt | Bundled with OCP Virt operator |
oc CLI |
Matching cluster version |
virtctl CLI |
Matching operator version |
make setup # Install all dependencies
make dev # Start local preview at http://localhost:8080Make your changes, then validate and submit:
make validate # Run all checks (lint, build, links, review)
make pr # Push and create PRSee CONTRIBUTING.md for the full contributor guide, including AsciiDoc conventions, testing, and the PR process.
- OpenShift Virtualization Documentation
- KubeVirt User Guide
- Antora Documentation
- AsciiDoc Language Reference
Contributions are welcome -- open new issues for topics you'd like to see, or comment on existing issues to request prioritization. See docs/ROADMAP.md for quarterly themes, design principles, and how to view the live project board.
Report bugs, suggestions, or improvements at https://github.com/RedHatQuickCourses/ocp-virt-cookbook/issues
See SECURITY.md for reporting security vulnerabilities.
See CODE_OF_CONDUCT.md for community standards.
This project is licensed under the MIT License. See LICENSE for details.