VMware: Automate OpenStack vApp deployment using PowerCLI

For those who wants to try OpenStack on VMware vSphere without struggling with GIT pulls and manual file edit the OpenStack Team at VMware provides the VOVA, (Vsphere Openstack Virtual Appliance) an Ubuntu virtual machine which comes with OpenStack Havana pre-installed and pre-configured to run on vSphere. To be clear this is not the entire OpenStack's stack, this comprises Nova, Glance, Cinder, and Keystone but according to the official community on VMTN there's the possibility to bring in another stack component like Neutron. This one will  require VMware NSX though.

OpenStack on vSphere requires though some infrastructure configurations in order to work, this is not the simple deploy the ova file and everything works. An initial setup must be performed in order to successfully deploy the VOVA.

Let's start by linking the official OpenStack on vSphere documentation in which you will find all instructions for a correct deployment as well as the link for downloading the OpenStack virtual appliance.

As official documentation states we will work with two different clusters: a management cluster where the VOVA vApp will be deployed and one or more OpenStack clusters. These clusters will be managed by OpenStack to deploy instances in. As best practice DRS will be enabled in both clusters and will be set in fully automated mode.

At least two datastores are also required: one, presented only to ESXi hosts belonging to management cluster, in which VOVA will be deployed and one, or preferably more, presented to all ESXi hosts in the OpenStack clusters that will be used by instances.

Networking-side some changes must be implemented: a new vSwitch with a private br100 PortGroup will be created on hosts in both OpenStack and management cluster. This PortGroup will be used by all OpenStack instances as well as by VOVA that will have NICs associated to different PortGroups: one on the br100 PortGroup forwarding packets received on that interface towards the outside network and vice-versa while the other on classic VM Network PortGroup to communicate with the rest of the network.

This is a logical schema giving an idea on how the environment should be configured:

Since some work is required in order to successfully use OpenStack on vSphere why not to automate its deployment using PowerCLI?

The following script:

-Connects to a vCenter Server
-Creates a Datacenter
-Creates two clusters: a Management and an OpenStack one
-Adds ESXi hosts to both clusters
-Configures ESXi hosts networking creating a vSwitch1 and a br100 PortGroup
-Deploys the OpenStack virtual appliance in one host belonging to the management cluster
-Configures OpenStack virtual appliance editing OVF Environment
-Starts up OpenStack and points user's browser to starting page

Here's how the final result will look like from vCenter:

This is the PowerCLI code, as usual you can find it also in my GitHub repository. Automate OpenStack vApp Deployment.ps1

	#Variable declaration
	$vCenterIPorFQDN="192.168.243.40"
	$vCenterPort="443"
	$vCenterUsername="Administrator@vsphere.local"
	$vCenterPassword="vmware"
	$DatacenterFolder="DCFolder"
	$DatacenterName="Datacenter"
	$MgmtClusterName="MgmtCluster"
	$OpenStackClusterNames=@("OpenStackCluster") #Cluster(s) managed by OpenStack
	$MgmtHosts= @("192.168.243.144") #IP or FQDN of hosts participating in Management Cluster
	$OpenStackHosts= @("192.168.243.143") #IP or FQDN of hosts participating in OpenStack Cluster
	$HostUsername="root" #This assumes every host in both clusters have same user/password
	$HostPassword="mypassword"
	$vSwitchName="vSwitch1" #vSwitch on which create br100 PortGroup
	$vSwitchNics= @("vmnic1") #Nics that will be associated to vSwitch1
	$portGroupName="br100" #PortGroup br100 used by OpenStack deployed VMs
	$vlanId=100 #VLAN ID of br100 PortGroup
	$SourceFilePath="C:\Users\Paolo\Downloads\VOVA_HAVANA.ova" #Path to VOVA file
	$InstallDatastore="DS_VOVA" #Datastore on which VOVA will be placed
	$DiskFormat="Thin" #Provisioning format: Thin | Thick | EagerZeroedThick
	$DatastoreRegex= @("Shared_Datastore") #Datastores used by OpenStack Instances. Regex are applicable
	$IPGateway="192.168.243.2"
	$IPDns="192.168.243.2"
	$IPappVOVA="192.168.243.150"
	$SubnetMaskappVOVA="255.255.255.0"
	Write-Host "Connecting to vCenter" -foregroundcolor "magenta"
	Connect-VIServer -Server $vCenterIPorFQDN -User $vCenterUsername -Password $vCenterPassword
	Write-Host "Creating Folder" -foregroundcolor "magenta"
	Get-Folder -NoRecursion | New-Folder -Name $DatacenterFolder
	#Create Datacenter
	Write-Host "Creating Datacenter" -foregroundcolor "magenta"
	New-Datacenter -Location $DatacenterFolder -Name $DatacenterName
	#Create Management Cluster
	Write-Host "Creating Management Cluster" -foregroundcolor "magenta"
	New-Cluster -Location (Get-Datacenter -Name $DatacenterName) -Name $MgmtClusterName -DRSEnabled:$true -DrsAutomationLevel FullyAutomated
	#Create Cluster managed by OpenStack
	foreach ($element in $OpenStackClusterNames) {
	Write-Host "Creating" $element "Cluster" -foregroundcolor "magenta"
	New-Cluster -Location (Get-Datacenter -Name $DatacenterName) -Name $element -DRSEnabled:$true -DrsAutomationLevel FullyAutomated
	}
	$i = 0 #Initialize loop variable
	foreach ($element in $MgmtHosts) {
	Write-Host "Adding" $element "to Management Cluster" -foregroundcolor "magenta"
	Add-VMHost $element -Location $MgmtClusterName -User $HostUsername -Password $HostPassword -RunAsync -force:$true
	Write-Host "One minute sleep in order to register" $element "into Management cluster" -foregroundcolor "magenta"
	Start-Sleep -s 60
	Write-Host "Setting up networking on" $element "host" -foregroundcolor "magenta"
	if ($i -le $MgmtHosts.Length) {
	#Create vSwitch1 on Management hosts
	New-VirtualSwitch -VMHost (Get-VMHost $element) -Name $vSwitchName -Nic $vSwitchNics | New-VirtualPortGroup -Name $portGroupName -VLanId $vlanId
	}
	$i++
	}
	$i = 0 #Purge loop variable
	foreach ($element in $OpenStackHosts) {
	Write-Host "Adding" $element "to OpenStack Cluster" -foregroundcolor "magenta"
	Add-VMHost $element -Location $OpenStackClusterNames[0] -User $HostUsername -Password $HostPassword -RunAsync -force:$true #This will add all hosts to the first cluster. If more than one iterate trough clusters.
	Write-Host "One minute sleep in order to register" $element "into OpenStack cluster" -foregroundcolor "magenta"
	Start-Sleep -s 60
	Write-Host "Setting up networking on" $element "host" -foregroundcolor "magenta"
	if ($i -le $OpenStackHosts.Length) {
	#Create vSwitch1 on OpenStack hosts
	New-VirtualSwitch -VMHost (Get-VMHost $element) -Name $vSwitchName -Nic $vSwitchNics | New-VirtualPortGroup -Name $portGroupName -VLanId $vlanId
	}
	$i++
	}
	#Upload the vSphere OpenStack Virtual Appliance to the first host of the Management Cluster, DRS will do the best placement
	Write-Host "Upload the vSphere OpenStack Virtual Appliance to" $MgmtHosts[0] -foregroundcolor "magenta"
	Import-vApp -VMHost $MgmtHosts[0] -Source $SourceFilePath -Datastore $InstallDatastore -DiskStorageFormat $DiskFormat -Force:$true
	$appVOVA = Get-VM "VOVA"
	#Assign second nic to br100 PG
	Write-Host "Configuring networking on" $appVOVA -foregroundcolor "magenta"
	Set-NetworkAdapter -NetworkAdapter (Get-NetworkAdapter -VM $appVOVA | Where-Object Name -eq "Network adapter 2") -NetworkName $portGroupName -Confirm:$false
	#Credits for vApp configuration code goes to Alan Renouf - http://www.virtu-al.net/2014/03/10/automating-deployment-log-insight-powercli/
	$VirtualMachineConfigSpec = New-Object VMware.Vim.VirtualMachineConfigSpec
	$VirtualMachineConfigSpec.vAppConfig = New-Object VMware.Vim.VmConfigSpec
	$VirtualMachineConfigSpec.vAppConfig.property = New-Object VMware.Vim.VAppPropertySpec[] (11) #Create an array of properties with these many elements
	$VirtualMachineConfigSpec.vAppConfig.property[0] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[0].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[0].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[0].info.key = 0 #Unique key
	$VirtualMachineConfigSpec.vAppConfig.property[0].info.value = $vCenterIPorFQDN #vCenter IP
	$VirtualMachineConfigSpec.vAppConfig.property[1] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[1].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[1].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[1].info.key = 1
	$VirtualMachineConfigSpec.vAppConfig.property[1].info.value = $vCenterPort #vCenter Port
	$VirtualMachineConfigSpec.vAppConfig.property[2] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[2].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[2].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[2].info.key = 2
	$VirtualMachineConfigSpec.vAppConfig.property[2].info.value = $vCenterUsername #vCenter Username
	$VirtualMachineConfigSpec.vAppConfig.property[3] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[3].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[3].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[3].info.key = 3
	$VirtualMachineConfigSpec.vAppConfig.property[3].info.value = $vCenterPassword #vCenter Password
	$VirtualMachineConfigSpec.vAppConfig.property[4] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[4].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[4].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[4].info.key = 4
	$VirtualMachineConfigSpec.vAppConfig.property[4].info.value = $DatacenterName #Datacenter Name
	$VirtualMachineConfigSpec.vAppConfig.property[5] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[5].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[5].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[5].info.key = 5
	$VirtualMachineConfigSpec.vAppConfig.property[5].info.value = $OpenStackClusterNames -join ', ' #Cluster(s) managed by OpenStack
	$VirtualMachineConfigSpec.vAppConfig.property[6] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[6].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[6].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[6].info.key = 6
	$VirtualMachineConfigSpec.vAppConfig.property[6].info.value = $DatastoreRegex -join ', ' #Datastore(s) managed by OpenStack
	$VirtualMachineConfigSpec.vAppConfig.property[7] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[7].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[7].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[7].info.key = 7
	$VirtualMachineConfigSpec.vAppConfig.property[7].info.value = $IPGateway #Default gateway
	$VirtualMachineConfigSpec.vAppConfig.property[8] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[8].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[8].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[8].info.key = 8
	$VirtualMachineConfigSpec.vAppConfig.property[8].info.value = $IPDns #DNS
	$VirtualMachineConfigSpec.vAppConfig.property[9] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[9].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[9].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[9].info.key = 9
	$VirtualMachineConfigSpec.vAppConfig.property[9].info.value = $IPappVOVA #Appliance IP address
	$VirtualMachineConfigSpec.vAppConfig.property[10] = New-Object VMware.Vim.VAppPropertySpec
	$VirtualMachineConfigSpec.vAppConfig.property[10].operation = "edit"
	$VirtualMachineConfigSpec.vAppConfig.property[10].info = New-Object VMware.Vim.VAppPropertyInfo
	$VirtualMachineConfigSpec.vAppConfig.property[10].info.key = 10
	$VirtualMachineConfigSpec.vAppConfig.property[10].info.value = $SubnetMaskappVOVA #Appliance Netmask
	$Reconfig = $appVOVA.ExtensionData
	$Configtask = $Reconfig.ReconfigVM_Task($VirtualMachineConfigSpec) #Apply changes by calling vSPhere API method ReconfigVM_Task
	#Poweron VOVA vApp
	Get-VM -Name $appVOVA | Start-VM
	#Wait some time until the vApp boots up then open the browser
	Start-Sleep -s 180
	Start-Process -FilePath "http://$IPappVOVA"

view raw Automate OpenStack vApp Deployment.ps1 hosted with ❤ by GitHub

The code is pretty well commented but some parts requires a further clarification:

 Import-vApp -VMHost $MgmtHosts[0] -Source $SourceFilePath -Datastore $InstallDatastore -DiskStorageFormat $DiskFormat -Force:$true  

imports a vApp in ova or ovf format to a designated ESXi host and datastore. DiskStorageFormat parameter is used to select how the vApp will be deployed in the datastore (Thin, Thick Lazy or Thick Eager).

The following code is used to edit OVF environment properties for the vApp since once deployed it needs to be configured in order to work properly.

These are the properties defined in VOVA:

 <PropertySection>  
    <Property oe:key="vami.DNS.VOVA" oe:value=""/>  
    <Property oe:key="vami.gateway.VOVA" oe:value=""/>  
    <Property oe:key="vami.ip0.VOVA" oe:value=""/>  
    <Property oe:key="vami.netmask0.VOVA" oe:value=""/>  
    <Property oe:key="vm.vmname" oe:value="VOVA"/>  
    <Property oe:key="vmware.cluster_name" oe:value=""/>  
    <Property oe:key="vmware.datacenter_name" oe:value=""/>  
    <Property oe:key="vmware.datastore_regex" oe:value=""/>  
    <Property oe:key="vmware.host_ip" oe:value=""/>  
    <Property oe:key="vmware.host_port" oe:value=""/>  
    <Property oe:key="vmware.password" oe:value=""/>  
    <Property oe:key="vmware.username" oe:value=""/>  
 </PropertySection>  

Credit for the code snippet goes to Alan Renouf .In his article Alan explains how to automate LogInsight vApp deployment by changing OVF environment properties using PowerCLI.

 $VirtualMachineConfigSpec = New-Object VMware.Vim.VirtualMachineConfigSpec  
 $VirtualMachineConfigSpec.vAppConfig = New-Object VMware.Vim.VmConfigSpec  
 $VirtualMachineConfigSpec.vAppConfig.property = New-Object VMware.Vim.VAppPropertySpec[] (x)  
 $VirtualMachineConfigSpec.vAppConfig.property[x] = New-Object VMware.Vim.VAppPropertySpec  
 $VirtualMachineConfigSpec.vAppConfig.property[x].operation = "edit"  
 $VirtualMachineConfigSpec.vAppConfig.property[x].info = New-Object VMware.Vim.VAppPropertyInfo  
 $VirtualMachineConfigSpec.vAppConfig.property[x].info.key = "Integer Key"  
 $VirtualMachineConfigSpec.vAppConfig.property[x].info.value = "Value"  
 $Reconfig = $appVOVA.ExtensionData  
 $Configtask = $Reconfig.ReconfigVM_Task($VirtualMachineConfigSpec)  

After the deployment your browser will be pointed to OpenStack console and you should see something similar to this:

Username is demo while password is vmware.

To create a new instance go to Instances

Launch Instance, select availability zone, instance name, flavor i.e. the "size" of the instance, instance boot source and finally the image to deploy. By default VOVA comprises a Debian image ready to be deployed.

Instance should take a few minutes to start the first time because VOVA will copy Debian image in one OpenStack managed datastore, subsequent deployments will be faster since files are already there.

Root privileges on deployed instances as well as in VOVA console can be accessed using root as username and vmware as password.

That's all!!