Build Status

Project

[Under Construction]: Currently only published zip is available for Public Usage, We are working towards making executable's OpenSource.

This project provides the source code for Azure Migrate hydration scripts. Hydration provides the capability to patch a VM disk brought onto azure with the necessary configuration changes to make the VM bootable on Azure. It also necessary adjustments for VM to be acquire a connectable state on Azure platform. Hydration aditionally makes confiuration changes to make VM Azure environment friendly by redirectly the console output to Azure's Serial Console, and install the VM Guest agent, required for VM extensions and post deployment configuration of a VM.

Requirements

The scripts available in this repository can only be used through Powershell with Az Module installed.

The script doesn't copy contents from OnPrem hypervisor VMs to an Azure Managed disk. It expects users to have an active subscription on azure with the disk contents present on an Azure managed disk.

For a Linux VM which is originally based out of Hyper-V hypervisor, it is possible for the VM to have Hyper-V LIS components missing. Before bringing the disk to Azure, it is expected for these components to be installed on the VMWare/Other hypervisors based VMs for hydration to work properly.

Some features may require additional internal tools such as:

dracut/mkinitrd, lsinitrd in Linux VMs if Hyper-V LIS modules are missing in kernel image.
dhclient/dhcpcd in Linux VMs if networking rules are not configured to DHCP.
Python 2.6+ for installation of Linux Guest Agent. Read additional basic requirements here. It's preferred to have setuptools appropriate for the python version installed on the OnPrem machine, but it's not a blocker.

Usage

Download the repository and unzip the package to retreive Hydration Scripts Folder.

Edit the Input.json file inside the Hydration Service folder, provide the specifications for the VM on which the patching has to be performed and final VM to be created with.

"ResourceGroupName" : "<Resource Group Name>",
"Location" : "<Location of the Azure Subscription, such as westeurope>",
"SubscriptionId" : "<Subscription Id>",
"OSType" : "<Specify whether the OS is a Windows VM or Linux VM: Acceptable Values: Windows, Linux>",
"OSDiskName" : "<Name of the OS Disk>",
"AttachDataDisks" : <Whether the VM has Data Disks. Acceptable Values: true, false>,
"NoOfDataDisks" : <Specify the number of data disks if true is passed as a value for parameter AttachDataDisks>,
"DataDisksName" : [
   "abc",
   "xyz"
],
"GithubBranch" : "main <optional: Details later>",
"AddCustomConfigSettings" : <true/false, <Optional> Disallow hydration from performing some non-essential tasks, such as DHCP and guest agent installation>,
"EnableDHCP" : <true/false>,
"EnableGA" : <true/false>,
"TargetVM_NICName" : "<NIC for the target VM For eg. nic-ubuntu18-04-bios-00-test>",
"TargetVM_VirtualMachineName" : "<Name of the final VM - ubuntu-github-test>",
"TargetVM_VirtualMachineSize" : "<Size of the final VM. For eg. Standard_B1ms>"

Final VM Size and NIC can be created based on the requirements as specified on NIC and VM Sizes.

Run CallPerformHydration.ps1. You will be required to sign in with your Azure Credentials once.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks