This section describes how to deploy, configure, and undeploy PrimaryIO Hybrid Cloud Data Management (HDM) 2.1.3 for enabling migrations of virtual machines to VMware Cloud Director (vCD).
HDM Deployment Steps
HDM deployment involves the following six steps, each of which is discussed in detail in the sections below:
- Deploy the HDM appliance on-premises
- Add the on-premises vCenter to the HDM appliance
- Register the HDM plug-in to the on-premises vCenter
- Add the HDM license
- Deploy HDM on-premises
- Deploy HDM in the cloud
Step 1: Deploy the HDM Appliance On-premises
Placement of HDM Appliance
- The appliance must be deployed on the same on-premises vCenter it will manage.
- The appliance should reside in a different cluster than the one it will manage for migrations.
Deployment and Configuration
The HDM appliance must be installed from the OVF in the HDM package. Be sure to check that the placement and sizing of the deployment conforms to the requirements mentioned above. To deploy the appliance, use the “Deploy OVF Template” option in vCenter (figure 6).
Figure 6: Launching the “Deploy OVF” Template in vCenter
Network Configuration for the Appliance
Appliance network configuration requires that the available networks be categorized into four types, described in the Network Requirements and HDM Resource Requirements sections, above. While it is recommended to keep these networks separate, it is possible for each of them to point to a single network. In addition, the decision must be made at this point to deploy using a static IP or DHCP protocol (figure 7).
Figure 7: Configuring the Network
IP Address Details
(If DHCP is chosen, this section can be skipped)
For each network type, choose the IP allocation protocol: static or DHCP. The following details are required if static IP is chosen (figure 8):
- IP range: list of IP addresses that are free to be allocated to various HDM components
- Subnet mask: subnet of the IP range
- Gateway: gateway IP of the network
- Domain: domain name of the network
- DNS: domain name translation for the IP address
- NTP: server that will be used for time synchronization
- If static IP is chosen, failure to specify an NTP server may cause further HDM operations to fail.
- If static IP is chosen, the gateway IP and the specified IP range must be in the same subnet.
Figure 8: Configuring the System for Static IP Protocol
The setting in Default gateway network should be chosen so
that traffic for other subnets can be routed through this interface. This would
generally be the WAN network but please verify the specifics for
In the field Default Gateway set the default gateway for the
network chosen under Default gateway network.
Getting this wrong will cause deployment to fail eventually and you will have to perform an HDM Reset
Figure 8b: Configuring gateway, NTP and default gateway
Power on the Appliance
Complete the rest of the wizard and wait for the deployment to complete. Then, use vCenter to power on the appliance.
Please note that the appliance can take between 5 to 10 minutes to boot depending on the underlying datastore's performance.
Enable VMware HA on the Appliance
(This step should only be performed for HDM cluster mode deployments)
VMware HA should be enabled on the cluster where the HDM appliance has been deployed. To complete this procedure, do the following:
- In the on-premises vCenter, select the cluster where the HDM appliance is deployed
- Select the “Configure” tab from the right-hand pane and navigate to Services 🡪 vSphere Availability
- If the vSphere HA is turned off, select EDIT and Enable vSphere HA
Step 2: Add the On-premises vCenter to the HDM Appliance
NOTE: The On-premises vCenter should be added to the same location as the HDM appliance.
- Ensure that the HDM appliance is powered on and valid vCenter administrator credentials are available.
- Log into the HDM Appliance by accessing https://<appliance ip> in a supported web browser and enter the administrator credentials. The default administrator username and password are ‘administrator’ and ‘2Hdm$aK!N@h!’, respectively. The default password should be changed immediately after the first login.
- Select vCenters from the top pane.
- Select Add vCenter at the top right (figure 9).
Figure 9: Adding vCenter to the HDM Appliance
- Specify the on-premises vCenter IP, or the FQDN that was set for the vCenter during its installation. Enter the administrator credentials, and then select Add vCenter. The HDM appliance should now list the on-premises vCenter (figure 10).
Figure 10: Viewing the On-Premises vCenter on the HDM Appliance
Step 3: Register the HDM Plug-in to On-premises vCenter
- Select Register to register the HDM plug-in to on-premises vCenter.
- Logout and login twice from the vCenter for the plug-in installation to complete. Successful installation should add an HDM icon to the vCenter home page (figure 11). Sometimes, multiple login/logout cycles may be required for this step to complete.
You might have to logout/login from the web client at least two times or more before the HDM plugin in visible in the vCenter
Figure 11: HDM Icon on the vCenter Home Page
NOTE: The PrimaryIO vCenter plug-in will be automatically registered on all vCenter instances that are configured in enhanced linked mode.
Step 4: Add the HDM License
Following deployment, a license key is required to activate HDM. A trial license will be shared with the product which can be used to activate HDM.
NOTE: Initial product settings need to be initialized, so it may take a few minutes to load the HDM configuration page.
Steps to add the HDM license:
- In the on-premises vCenter, access the HDM dashboard by selecting HDM from Shortcuts or the vCenter menu (It may take a few minutes for the dashboard to load).
- Select the _Administration _tab.
- Select Licensing to add a new license, and to see existing licenses (figure 12).
- Select _Add License _to open a popup where the provided Trial License can be pasted (figure 13).
- Copy and paste the shared license key and select OK. The license will now be listed on the license page (figure 14).
- The same interface can then be used to add the actual Product License obtained as part of the ordering process.
Figure 12: Add or See HDM Licenses
Figure 13: "Add License" Pop-up
Figure 14: Verify the Addition of the Trial License
Step 5: Deploy HDM On-premises
Depending on the network bandwidth and storage, it may take between 10 and 20 minutes to deploy HDM on-premises. Any failure-retries during the deployment process will be logged into vCenter Events. To search for events generated by HDM, hdm or com.primaryio keywords can be used in vCenter event search.
At this point, it is assumed that the HDM appliance deployment and configuration steps have been successfully completed. Ensure that the HDM plug-in has been registered on vCenter and the HDM icon is visible on the vCenter home screen. A valid HDM license must be added to activate the product.
- To access the HDM dashboard from the on-premises vCenter, select HDM from Shortcuts or the Menu.
- Select the _Administration _tab, followed by Configuration to access the on-premises cluster listing (figure 15).
Figure 15: vCenter On-Premises Cluster Listing
- Select the cluster where the HDM will be installed and select Install. This will open the HDM Installation Wizard (figure 16).
- Verify that the HDM appliance IP address is correct.
- Select the desired deployment mode based on your scale and failure tolerance requirements. See the Deployment Requirements section for details on the various deployment modes.
- Select resource allocation based on your size and resource requirements. See Deployment Requirements section for details on the various allocation types.
Figure 16: HDM Installation Wizard
**NOTE: **For migration to vCD, select _Ultra-Lite_ as the resource allocation mode.** **
- Select the resource pool and shared datastore where the HDM components will be deployed (figure 17). Before selecting the deployment mode, take care to ensure that enough resources are available on-premises and in the cloud.
Figure 17: Resource Pool and Shared Datastore Selection
To specify the internal network configurations, start by choosing the IP allocation protocol: static or DHCP (figure 18). The following details are required if static IP is chosen:
- IP range
- Subnet mask
See the Deployment Requirements section for additional details on these requirements. These steps must be repeated for the following components:
- HDM Internal Network (HDM_Internal_Network)
- WAN Network (Uplink_WAN_Network)
ESXi Network (ESXi_Network)
- If all are mapping to single network, separate IP ranges must be provided for each network type.
- The subnet range 172.17.0.0/16 is not available for the deployment; it is used internally by HDM microservices.
Figure 18: Network Configuration Settings
- Confirm the selection and submit the installation request by clicking on the FINISH button (figure 19).
Figure 19: HDM Installation Summary
- This will create a deployment task which can be monitored from vCenter Tasks. The deployment progress can also be seen in the HDM Configuration view within vCenter (figure 20).
Figure 20: vCenter HDM Configuration View
Step 6: Deploy HDM in the Cloud
Depending on the WAN bandwidth and WAN latency, it may take between 10 and 20 minutes to deploy HDM components in the cloud. Any failure-retries during the deployment process will be logged into vCenter Events. To search for events generated by HDM, hdm or com.primaryio keywords can be used in vCenter event search.
- Ensure that the HDM plug-in has been registered on vCenter and the HDM icon is visible on the home screen.
- Ensure that the on-premises deployment has successfully completed.
- Ensure that the vCenter cloud is reachable from the HDM appliance. If cloud vCD is on the WAN and the WAN is not reachable through the appliance’s default route, then a static entry must be added to the HDM appliance to reach the cloud vCD. This can be accomplished by following these steps:
- vim /etc/pio.routes and add the entry
- HDM_INTERNAL_NETWORK and WAN Network should be connected to the selected vApp.
- To access the HDM dashboard from the on-premises vCenter, select HDM from Shortcuts or the Menu.
- Select the Administration tab, then Clouds to access the cloud listing (figure 21).
Figure 21: vCenter Cloud Listing
- Select Add Cloud. This will open the HDM Cloud Wizard (figure 22).
- Select the Cloud type and enter your vCD credentials and the Cloud DNS.
Figure 22: HDM Cloud Wizard
- Select vDC, vApp and storage profile cloud where HDM components will be deployed (figure 23). You must use a Storage Profile of at least 10 IOPS/GB or standard for deployment.
Figure 23: Select Cloud Cluster
- Select the network and IP configuration for ON_CLOUD_HDM_NETWORK (HDM Internal Network) that will be used by HDM for VM boot and subsequent IO handling through the HDM components. Choose the IP allocation protocol: static, static pool, or DHCP (figure 24). If static IP address allocation is chosen, the unused IP addresses or IP ranges, along with the gateway and subnet mask, would need to be specified.
Figure 24: Network Configuration
- Select network IP configurations for the WAN. Choose the IP allocation protocol: static, static pool, or DHCP (figure 25). If static IP address allocation is chosen, the unused IP addresses or IP ranges, along with the gateway and subnet mask, domain search path, and one or more DNS and NTP servers, would need to be specified
Figure 25: WAN Configuration
- Set WAN route configuration to enable data traffic to travel from the cloud to the on-premises environment (figure 26). See the network planning section WAN Routing Configuration.
Figure 26: WAN Route Configuration
- Select network mapping to enable the on-premises network categorization to also be applied to cloud components (figure 27).
Figure 27: Network Mapping
- To submit the request and initiate the cloud deployment, select FINISH. This will create deployment tasks for the cloud components, which can be monitored in vCenter Tasks. The progress can also be seen in the HDM Clouds view (figure 29).
After you submit the request, the cloud deployment can take from 45 minutes to
over an hour, depending on storage and network performance. Please note
that the progress bar displayed during this process is not linear and
specific steps take longer, resulting in the progress bar spending
longer time at a certain percentage.
For the Cloud deployment task, it takes about 40-50 minutes at 1%.
Under the Organization VDC upload ISO task, stays at 50% for
about 25 minutes.
Under the Organization VDC upload OVF task, lingers at 1% for about 20 minutes.
Figure 28: Summary and Request Submission
Figure 29: HDM Clouds View
Once the on-premises and cloud deployments have completed, the state of the components can be viewed in the following ways:
After successful installation of HDM in the cloud, the HDM appliance control panel shows the list of components and their health (figure 30). This information can also be viewed from the HDM plug-in in vCenter (figure 31).
Figure 30: HDM Appliance Control Panel
Figure 31: vCenter HDM Plug-In
To verify that the on-premises vCenter shows the cloud state as installed, select HDM, then the Administration and _Clouds _tabs.
Figure 32: Verify Installation of the Cloud State
NOTE: Configuration information needs to be gathered and loaded from vCD, so it may take a few minutes to load the Cloud Dashboard for the first time.
Troubleshooting Common Failure Scenarios
Common failure scenarios and their possible reasons are discussed below. If the failure is not one of the above reasons and the error message is not clear, please contact PrimaryIO Support.
Some common reasons for deployment failures are:
- Insufficient resources. On-premises or cloud resources are not sufficient to meet the requirements for the specified deployment mode.
- Unresolved input values. Inputs such as vCenter FQDN/IP are either unresolvable or unreachable.
- IP range issues. For static IP allocation, the specified IP range is insufficient for all HDM components.
- HDM component failed during or after the deployment. The HDM component failed during deployment.
Usually, the deployment UI wizard or vCenter tasks fail with error message pointing to one of the above reasons. The errors can be rectified and either a re-deployment can be initiated or an HDM reset followed by re-deployment should be attempted.
Common reasons for undeployment failures are:
- VMs are still migrated to the cloud when undeployment is attempted. (This is applicable to TBC only)
- The on-premises cluster host is unable to enter maintenance mode, for one of the following reasons:
- DRS is not enabled on the cluster, thereby causing powered-on VMs to block the maintenance mode
- The HDM appliance is part of a single host cluster. Therefore, the HDM appliance being powered-on blocks the maintenance mode. In this case, the user should immediately power off the HDM appliance.
Monitoring the vCenter tasks will provide the reason for an undeployment failure. If it is one of the above, rectify the reason for the failure and re-attempt the operation.
Support and Contact
In case of any issue, HDM support can be contacted via **email: [email@example.com](mailto:firstname.lastname@example.org)**
The email should contain the following:
- Email subject: Clearly highlight the issue.
- Email body: Clearly describe the problem. It can contain the deployment type, the operation being performed, any relevant screenshots, etc.
Email attachment: Attach the relevant logs (see the HDM Support Logs section for instructions):
If the attachment size is too large, an alternate shared location may be provided by HDM Support where the logs can be uploaded.