Skip to content

Latest commit

 

History

History

README.md

Virtwork Guide

This guide walks you through how virtwork works, how to deploy workloads with it, and how to extend it with new workload types. It complements the reference documentation with narrative explanations and hands-on demos.

Who This Guide Is For

  • Operators who want to deploy workload VMs on OpenShift and understand what they produce
  • Developers who want to add new workload types or contribute to the project

Prerequisites

  • Familiarity with Kubernetes/OpenShift concepts (namespaces, pods, services)
  • For the deployment demo: an OpenShift cluster with OpenShift Virtualization (CNV) installed
  • For the developer tutorial: Go 1.26+ and the Ginkgo CLI

Guide Sections

  1. How Virtwork Works — Build a mental model of how the pieces fit together by tracing a single run through the system
  2. Demo: Deploying Workloads — Nine hands-on scenarios from dry run to SSH debugging to cleanup
  3. Tutorial: Building an HTTP Workload — Code a new workload type from scratch using TDD
  4. Tutorial: Adding a Catalog Workload — Create a custom workload without writing Go code, using systemd service files and a YAML manifest

Reference Documentation

  • README — Quick start, CLI reference, configuration, audit tracking, OpenShift deployment
  • Architecture — Layered architecture diagrams and design decisions
  • Development — Developer environment setup, testing, adding workloads (reference)