Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 30, 2025

This PR adds comprehensive documentation and an example runbook for the Hyper-V platform to support running LISA tests on Windows 10/11 desktop environments.

Changes Made

Documentation Added (docs/run_test/platform.rst)

  • New "Run on Hyper-V" section with complete platform documentation
  • Prerequisites and setup requirements for Hyper-V on Windows 10/11
  • Basic and advanced configuration examples
  • Parameter explanations for all Hyper-V-specific options (admin credentials, VM generation, source files, etc.)
  • Usage examples for both local and remote Hyper-V hosts
  • Proper integration with existing platform documentation structure

Example Runbook Added (microsoft/runbook/hyperv.yml)

  • Complete runbook following established LISA conventions
  • All necessary variables with sensible defaults
  • Proper platform configuration matching HypervPlatformSchema
  • Integration with existing test tier system
  • Support for both local (localhost) and remote Hyper-V servers

Use Case

This enables the workflow described in the original issue for users who want to:

  • Use Hyper-V on Windows 10/11 desktops for development and testing
  • Test desktop Linux distributions that may not be available in cloud environments
  • Have local VM management and control for reproducibility
  • Leverage LISA's test automation capabilities in desktop environments

Example Usage

# Run tests on local Hyper-V with a VHD file
lisa -r ./microsoft/runbook/hyperv.yml \
  -v "vhd_admin_username:testuser" \
  -v "vhd_admin_password:password123" \
  -v "vhd:/path/to/ubuntu-desktop.vhd"

The implementation leverages the existing Hyper-V platform that was already implemented (first phase completed) and provides the documentation and example that users need to get started.

Fixes #3327.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@LiliDeng
Copy link
Collaborator

@Copilot Copilot AI changed the title [WIP] Supporting Hyper-V on Windows 10/11? Add Hyper-V platform documentation and example runbook May 30, 2025
@Copilot Copilot AI requested a review from LiliDeng May 30, 2025 03:47
Copilot finished work on behalf of LiliDeng May 30, 2025 03:47
Copy link
Contributor Author

Copilot AI commented May 30, 2025

@copilot write doc here https://github.com/microsoft/lisa/blob/main/docs/run_test/platform.rst for hyperv platform https://github.com/microsoft/lisa/tree/main/lisa/sut_orchestrator/hyperv

I've written comprehensive documentation for the Hyper-V platform in docs/run_test/platform.rst. The documentation now covers all platform features including device passthrough, serial console access, networking configuration, source file options, troubleshooting, and complete parameter explanations based on the actual implementation. See commit 8471a13.

Copilot finished work on behalf of LiliDeng May 30, 2025 03:52
@LiliDeng LiliDeng requested a review from Copilot June 15, 2025 03:55
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds comprehensive Hyper-V platform support by including both an example runbook and detailed documentation to guide users through setup and usage.

  • Introduces microsoft/runbook/hyperv.yml as a canonical example runbook for local and remote Hyper-V configurations.
  • Expands docs/run_test/platform.rst with a full "Run on Hyper-V" section covering prerequisites, parameters, and advanced scenarios.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
microsoft/runbook/hyperv.yml New example runbook illustrating all Hyper-V-specific options
docs/run_test/platform.rst Added “Run on Hyper-V” section with setup, parameters, examples, and troubleshooting
Comments suppressed due to low confidence (2)

docs/run_test/platform.rst:373

  • Add an explicit Sphinx reference label (e.g., .. _run-on-hyper-v:) immediately above this header to ensure the TOC link (<#run-on-hyper-v>__) resolves correctly.
Run on Hyper-V

microsoft/runbook/hyperv.yml:11

  • [nitpick] Consider adding an admin_private_key_file variable (with an empty default) to illustrate SSH key–based authentication as an alternative to password, matching the documentation.
    is_secret: true

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supporting Hyper-V on Windows 10/11?

2 participants