ntnu-openstack-imaging

Scripts for creating Windows images suitable for OpenStack using the Windows OpenStack Imaging Tools.

Overview

This repository contains PowerShell scripts that automate the creation of Windows images for OpenStack environments. The scripts leverage the Windows OpenStack Imaging Tools from Cloudbase Solutions to create properly configured QCOW2 and RAW images with VirtIO drivers and Cloudbase-Init installed.

Prerequisites

Windows host with Hyper-V enabled
- The scripts require Hyper-V to create the virtual machines during image generation
- Enable via: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All
Windows OpenStack Imaging Tools
- Download from: https://github.com/cloudbase/windows-imaging-tools
- Extract to a location on your system (e.g., D:\Tools\windows-openstack-imaging-tools)
VirtIO drivers ISO
- Download from: https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/
- Save to a location on your system (e.g., D:\ISO\virtio-win-0.1.285.iso)
Windows Server ISO
- Obtain the Windows Server installation ISO you wish to use
- Supported versions include Windows Server 2016, 2019, 2022, 2025, etc.
External Hyper-V virtual switch
- An external Hyper-V switch is required for networking during image creation
- Must be an external switch if UpdateImage is set to $true to provide internet access for Windows updates
- Create via Hyper-V Manager or PowerShell if it doesn't exist
- You'll specify the switch name via the HypervNetwork parameter

Scripts

CreateOpenStackImage.ps1

The main script that performs the actual image creation process. This script:

Mounts the Windows ISO and allows you to select which edition to install (e.g., Standard, Datacenter, Core)
Configures image settings including disk size, VM resources, and drivers
Creates a Hyper-V VM to build the image
Installs VirtIO drivers for optimal performance in OpenStack
Installs and configures Cloudbase-Init for cloud initialization
Generates both QCOW2 and RAW format images
Appends the current date to the output filename
Supports custom scripts from the CustomScripts subfolder (or specified path)
Supports custom resources from the CustomResources subfolder (or specified path)

Parameters

Parameter	Required	Description	Example
`ImagingToolsPath`	Yes	Path to Windows OpenStack Imaging Tools	`D:\Tools\windows-openstack-imaging-tools`
`VirtIOISOPath`	Yes	Path to VirtIO drivers ISO	`D:\ISO\virtio-win-0.1.285.iso`
`WinISOPath`	Yes	Path to Windows Server ISO	`D:\ISO\WinServer2025.iso`
`OutputImagePath`	Yes	Directory for output images	`D:\Images`
`OutputImageName`	Yes	Base name for output image	`WinServer2025_Core`
`UpdateImage`	Yes	Apply Windows updates during creation	`$true` or `$false`
`HypervNetwork`	Yes	Name of Hyper-V external switch (must be external if UpdateImage is true)	`ext-net`
`diskSize`	No	Size of virtual disk (default: `40GB`)	`60GB`
`ramSize`	No	RAM allocated to build VM (default: `32GB`)	`16GB`
`cpuCount`	No	CPU cores for build VM (default: `16`)	`8`
`CustomScriptsPath`	No	Path to custom scripts (default: `CustomScripts` subfolder)	`C:\Tools\Scripts`
`CustomResourcesPath`	No	Path to custom resources (default: `CustomResources` subfolder)	`C:\Tools\Resources`
`TempFolder`	No	Temporary folder (default: `C:\Temp`)	`C:\Temp`
`StaticIPConfig`	No	Hashtable with static IP configuration for the build VM	See example below

Image Configuration

The script configures the following default settings:

Disk size: 40 GB (configurable via diskSize parameter)
RAM: 32 GB (configurable via ramSize parameter, used during build process)
CPU count: 16 cores (configurable via cpuCount parameter, used during build process)
Disk layout: UEFI
Virtual disk format: QCOW2 (with RAW conversion)
Image type: KVM
Time zone: W. Europe Standard Time
Networking: IPv6 EUI64 and ping enabled
Windows Updates: Controlled by UpdateImage parameter (requires internet access via external switch when enabled)
Update cleanup: Updates are purged if UpdateImage is true to reduce image size
Build VM networking: DHCP by default, or static IP if StaticIPConfig parameter is provided

Usage

.\CreateOpenStackImage.ps1 `
    -ImagingToolsPath "D:\Tools\windows-openstack-imaging-tools" `
    -VirtIOISOPath "D:\ISO\virtio-win-0.1.285.iso" `
    -WinISOPath "D:\ISO\WinServer2025.iso" `
    -OutputImagePath "D:\Images" `
    -OutputImageName "WinServer2025_Core" `
    -UpdateImage $true `
    -HypervNetwork "ext-net"

# Optional: With custom VM resources
.\CreateOpenStackImage.ps1 `
    -ImagingToolsPath "D:\Tools\windows-openstack-imaging-tools" `
    -VirtIOISOPath "D:\ISO\virtio-win-0.1.285.iso" `
    -WinISOPath "D:\ISO\WinServer2025.iso" `
    -OutputImagePath "D:\Images" `
    -OutputImageName "WinServer2025_Core" `
    -UpdateImage $true `
    -HypervNetwork "ext-net" `
    -diskSize "60GB" `
    -ramSize "16GB" `
    -cpuCount "8"

# Optional: With static IP configuration for the build VM
$staticIP = @{
    IPAddress = "10.99.12.26"
    PrefixLength = 22
    DefaultGateway = "10.99.12.1"
    DNSServers = @("129.241.0.200","129.241.0.201")
}

.\CreateOpenStackImage.ps1 `
    -ImagingToolsPath "D:\Tools\windows-openstack-imaging-tools" `
    -VirtIOISOPath "D:\ISO\virtio-win-0.1.285.iso" `
    -WinISOPath "D:\ISO\WinServer2025.iso" `
    -OutputImagePath "D:\Images" `
    -OutputImageName "WinServer2025_Core" `
    -UpdateImage $true `
    -HypervNetwork "ext-net" `
    -StaticIPConfig $staticIP

During execution, the script will:

Display available Windows editions from the ISO
Prompt you to select the image index number
Create the image with the date appended (e.g., WinServer2025_Core_20251205.qcow2)
Generate both QCOW2 and RAW format files

Start-ImageCreation.ps1

A wrapper script that simplifies the image creation process by providing predefined paths for commonly used parameters. This allows you to only specify the Windows ISO path and output image name.

Parameters

Parameter	Required	Description	Example
`WinISOPath`	Yes	Path to Windows Server ISO	`D:\ISO\WinServer2025.iso`
`OutputImageName`	Yes	Base name for output image	`WinServer2025_Core`

Note: The wrapper script has UpdateImage hardcoded to $true by default, meaning Windows updates will be installed during image creation. Edit the script if you want to disable updates.

Configuration

Edit the predefined paths in the script before use:

$netconfiguration = @{
    IPAddress = "10.99.12.26"
    PrefixLength = 22
    DefaultGateway = "10.99.12.1"
    DNSServers = @("129.241.0.200","129.241.0.201")
}

$parameters = @{
    ImagingToolsPath = "D:\Tools\windows-openstack-imaging-tools"
    VirtIOISOPath    = "D:\ISO\virtio-win-0.1.285.iso"
    WinISOPath       = $WinISOPath
    OutputImagePath  = "D:\Images"
    OutputImageName  = $OutputImageName
    UpdateImage      = $true  # Set to $false to skip Windows updates
    HypervNetwork    = "ext-net"
    TempFolder       = "C:\Temp"
    StaticIPConfig   = $netconfiguration  # Optional: Remove or set to $null for DHCP
}

Usage

.\Start-ImageCreation.ps1 `
    -WinISOPath "D:\ISO\WinServer2025.iso" `
    -OutputImageName "WinServer2025_Core"

Output

The scripts generate two image files in the specified output directory:

<OutputImageName>_<DATE>.qcow2 - QCOW2 format (for OpenStack Glance)
<OutputImageName>_<DATE>.raw - RAW format (converted from QCOW2)

Example output:

WinServer2025_Core_20251205.qcow2
WinServer2025_Core_20251205.raw

Uploading to OpenStack

After image creation, upload to OpenStack Glance. Check with your OpenStack environment for specific requirements. Example command:

openstack image create \
	--file WinServer2025_Core_20251205.raw \
	--disk-format raw \
	--min-disk 20 \
	--min-ram 2048 \
	--private \
	--progress \
	--property os_type='windows' \
	--property os_distro='windows' \
	--property os_secure_boot='required' \
	--property hw_firmware_type='uefi' \
	--property hw_machine_type='pc-q35-6.2' \
	"Windows Server 2025 Standard Core (UEFI SecureBoot) 20251118"

Additional Scripts

The CustomScripts folder supports the following custom scripts that can be used to perform additional configuration at various stages of the image creation process:

RunBeforeWindowsUpdates.ps1 - Custom script executed before Windows updates are installed
RunAfterWindowsUpdates.ps1 - Custom script executed after Windows updates are installed
RunBeforeCloudbaseInitInstall.ps1 - Custom script executed before Cloudbase-Init installation
RunAfterCloudbaseInitInstall.ps1 - Custom script executed after Cloudbase-Init installation
RunBeforeSysprep.ps1 - Custom script executed before Sysprep generalization
RunAfterSysprep.ps1 - Custom script executed after Sysprep generalization

These scripts can be customized to perform additional configuration during the image creation process. Place your custom scripts in the CustomScripts subfolder (or specify a different path via the CustomScriptsPath parameter).

Troubleshooting

Hyper-V not enabled: Ensure Hyper-V is enabled on your host system
External switch not found: Create an external Hyper-V switch and specify its name via the HypervNetwork parameter
Insufficient disk space: Ensure adequate space in the output directory and temp folder
ISO mount fails: Verify ISO paths are correct and files are not corrupted
VirtIO drivers missing: Ensure the VirtIO ISO path points to a valid drivers ISO

winserver/ntnu-openstack-imaging

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Packages