Written by Jason Yi, PM on the Azure Edge & Platform team at Microsoft.
Introduction
As we introduce the new generation VMFleet, we also want to provide a quick how to guide to help you quickly get started! Today we will cover 2 paths you can take: using the traditional and customized VMFleet test vs using the new pre-defined workload profile. Let’s dive in.
From Setup to Start-FleetSweep
This is the traditional path of setting up VMFleet and running it using your desired DiskSpd parameters/flags.
Prerequisites
Before we begin setting up VMFleet, there are a few prerequisites that you should have ready.
- Ensure that you have 1 CSV per node
- Within Storage Spaces Direct, CPU usage is based on the host. Therefore, it is recommended that you split the storage load by creating as many CSVs as there are host nodes. We can go ahead and create a CSV per node in the cluster.
- You may run the following:
Get-ClusterNode |% {
New-Volume -StoragePoolFriendlyName S2D* -FriendlyName $_ -FileSystem CSVFS_ReFS -Size <DESIRED SIZE>
}
- Ensure that you create a “collect” volume.
- You may run the following:
New-Volume -StoragePoolFriendlyName S2D* -FriendlyName collect -FileSystem CSVFS_ReFS -Size 200GB
- If you have ran VMFleet in the past, please ensure that prior VMFleet directories are completely removed from existing volumes.
- Retrieve or install a Server Core VHDX file. If you do not have one handy, we can create a new one by following the below instructions.
- Download WS2019 Server Core ISO from the public website.
- Open Hyper-V Manager.
- Click “New”, then “Virtual Machine”.
- Navigate through the prompts and pick a location to store your VM.
- Once your VM is created, boot up the VM and follow the instructions. This is where you will decide your VM password, or what we will later call, “adminpass”.
- This is important as we will use this later, so make sure you write this down.
- Log out of the VM, and navigate to where you stored your VM. You should find a “Virtual Hard Disks” folder. Inside, you should find your new Server Core VHDX file.
- Rename it to “Gold.vhdx”.
- Copy or move the file to the cluster environment that you want to run VMFleet in.
- Done!
Deployment
- First, we need to install the new PowerShell Module from the PowerShell Gallery and then load it into our terminal. Run the following:
Install-Module -Name “VMFleet”
Import-Module VMFleet
- Sanity Check:
- Run "Get-Module VMFleet" to confirm the module exists.
- Run "Get-Command -Module VMFleet" to obtain a list of functions included in the module.
- We will now set up the directory structure within the “Collect” CSV created earlier. Run "Install-Fleet"
- This creates the necessary VMFleet directories which include:
- Collect/control
- Contains the scripts that the Virtual Machines continuously monitor.
- Control.ps1: the control script the VMs use to implement the control loop (what used to be called “master.ps1”).
- Run.ps1: The VMs continuously look for the most recent version of run.ps1 and runs the newly updated script (parameters).
- Collect/flag
- Location where the control script drops the “go”, “pause”, and “done” flag files. Users should not need to look at these files.
- Collect/result
- Location of the output files from the VMFleet test run.
- Collect/tools
- DiskSpd will be preinstalled in this folder.
- Collect/control
- Note: Please move the VHDX file into this collect folder. CSV Cache is also turned off by default.
- We will now create our “fleet” of VMs by running:
New-Fleet -basevhd <PATH TO VHDX> -vms [ENTER_NUM_VMS] -adminpass [ENTER_ADMINPASS] -connectuser [ENTER_NODE_USER] -connectpass [ENTER_NODE_PASS]
- "adminpass" is the administrator password for the Server Core Image. This is the password you set on your Virtual Machine earlier.
- "connectuser" is a domain account with access to the cluster.
- "connectpass " is the password for the above domain account.
- "vms" is the number of VM's to create per node.
- If this parameter is not provided, the default is a 1:1 subscription ratio where the Number of VMs = Number of physical cores.
- [Optional] You can consider modifying the VM hardware configuration. Run
Set-Fleet -ProcessorCount 1 -MemoryStartupBytes 2gb -MemoryMaximumBytes 2gb -MemoryMinimumBytes 2gb
Note:
- If you specify “MemoryMaximumBytes”, you must specify “MemoryMinimumBytes”, which implies that your VMs will have dynamic memory.
- If you omit “MemoryMaximumBytes” or “MemoryMinimumBytes”, it implies that your VMs will have static memory.
- If MemoryStartupBytes = MemoryMinimumBytes = MemoryMaximumBytes, that also denotes static memory.
- “MemoryStartupBytes” is a mandatory parameter.
- It is recommended that the number of vCPUs should not exceed the number of logical processors. If you would like more information, refer to this: Understanding and using Hyper-V hypervisor scheduler types | Microsoft Docs
Start Running VMFleet!
- Open 2 PowerShell terminals. In the first one, run Watch-Cluster and in the second one, run Start-Fleet. This second function will turn on all the VMs in a “paused” state.
- At this point you can run Start-FleetSweep [ENTER_PARAMETERS] or take this time to explore and run any of the other functions!
- Here is a sample sweep command to help you get started: "Start-FleetSweep -b 4 -t 8 -o 8 -w 0 -d 300 -p r"
- Done!
Aftermath
Once you are done running VMFleet you can run Stop-Fleet to shut down all the virtual machines or run Remove-Fleet to completely delete all the virtual machines on your environment.
From Setup to Measure-FleetCoreWorkload
This is a new workflow for setting up VMFleet and the predefined profile workloads (General, Peak, VDI, SQL).
Prerequisites
Before we begin setting up VMFleet, there are a few prerequisites that you should have ready.
- Ensure that you have 1 CSV per node
- Within Storage Spaces Direct, CPU usage is based on the host. Therefore, it is recommended that you split the storage load by creating as many CSVs as there are host nodes. We can go ahead and create a CSV per node in the cluster.
- In order to be precise about the CSV size, please use our new VMFleet command: "Get-FleetVolumeEstimate"
- This will output a prescribed CSV size based on different resiliency types. We recommend you select a 2-way mirrored value or 3-way mirrored value depending on your node count.
- You may run the following: (use the CSV size from Get-FleetVolumeEstimate)
Get-ClusterNode |% {
New-Volume -StoragePoolFriendlyName S2D* -FriendlyName $_ -FileSystem CSVFS_ReFS -Size <DESIRED SIZE>
}
- Ensure that you create a “collect” volume.
- You may run the following:
New-Volume -StoragePoolFriendlyName S2D* -FriendlyName collect -FileSystem CSVFS_ReFS -Size 200GB
- If you have ran VMFleet in the past, please ensure that prior VMFleet directories are completely removed from existing volumes.
- Retrieve or install a Server Core VHDX file. If you do not have one handy, we can create a new one by following the below instructions.
- Download WS2019 Server Core ISO from the public website.
- Open Hyper-V Manager.
- Click “New”, then “Virtual Machine”.
- Navigate through the prompts and pick a location to store your VM.
- Once your VM is created, boot up the VM and follow the instructions. This is where you will decide your VM password, or what we will later call, “adminpass”.
- This is important as we will use this later, so make sure you write this down.
- Log out of the VM, and navigate to where you stored your VM. You should find a “Virtual Hard Disks” folder. Inside, you should find your new Server Core VHDX file.
- Rename it to “Gold.vhdx”.
- Copy or move the file to the cluster environment that you want to run VMFleet in.
- Done!
Deployment
- Let’s begin deploying VMFleet. First, we need to install the new PowerShell Module from the PowerShell Gallery and then load it into the terminal. Run the following:
Install-Module -Name “VMFleet”
Import-Module VMFleet
- Sanity Check:
- Run "Get-Module VMFleet" to confirm the module exists.
- Run "Get-Command -Module VMFleet" to obtain a list of commands included in the module.
2. We will now set up the directory structure within the “Collect” CSV that we created earlier. Run "Install-Fleet"
- This creates the necessary VMFleet directories which include:
3. We will now create our “fleet” of VMs by running:
New-Fleet -basevhd <PATH TO VHDX> -adminpass [ENTER_ADMINPASS] -connectuser [ENTER_NODE_USER] -connectpass [ENTER_NODE_PASS]
- "adminpass" is the administrator password for the Server Core Image. This is the password you set on your Virtual Machine earlier.
- "connectuser" is a domain account with access to the cluster.
- "connectpass " is the password for the above domain account.
- "vms" is the number of VM's to create per node.
- Please do not provide this parameter, we will use our default subscription ratio of 1:1. Number of VMs = Number of physical cores.
4. Measure-FleetCoreWorkload also collects diagnostic data (Get-SDDCDiagnosticInfo). Therefore, before running the command, we must also install the NuGet Package if you have not previously done so. In doing so, we also need to temporairly set the PSGallery as a trusted repository source (Note: This will temporarily relax the security boundary).
$repo = Get-PSRepository -Name PSGallery
if ($null -eq $repo) { Write-Host "The PSGallery is not configured on this system, please address this before continuing" }
else {
if ($repo.InstallationPolicy -ne 'Trusted') {
Write-Host "Setting the PSGallery repository to Trusted, original InstallationPolicy: $($repo.InstallationPolicy)"
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
}
### Installing the pre-requisite modules
Install-PackageProvider NuGet -Force
Install-Module -Name PrivateCloud.DiagnosticInfo -Force
Install-Module -Name MSFT.Network.Diag -Force
if ($repo.InstallationPolicy -ne 'Trusted') {
Write-Host "Resetting the PSGallery repository to $($repo.InstallationPolicy)"
Set-PSRepository -Name PSGallery -InstallationPolicy $repo.InstallationPolicy
}
}
Run Measure-FleetCoreWorkload!
5. We can now run Measure-FleetCoreWorkload. Running the command below will automatically run all 4 workloads (General, Peak, VDI, SQL) and place the individual outputs in the result directory. IMPORTANT: If you plan on running another test, please clear the result directory.
Measure-FleetCoreWorkload
6. Congratulations! You’re done! All you need to do is wait for the test to complete.
- Note: If you ever run into an error and need to rerun Measure-FleetCoreWorkload, don’t be afraid to do so! It is smart enough to pick up from where it last stopped and continue the test without starting from scratch.
Updated Jun 27, 2022
Version 2.0
