DocsKnowledge BaseAPI Explorer
Documentation›ZVF›ZStack ZMigrate›Migration ServiceZVF

Overview

The migration service migrates VMs, including their operating systems and data, from other virtualization platforms to ZStack ZSphere. Supported source platforms include VMware vSphere and other KVM-based cloud platforms. A step-by-step wizard guides you through the end-to-end migration process.

Step 1: Upload the Migration Service Package

After uploading the installation package, the system automatically decompresses it and extracts the required files.

Before you begin

  • Ensure that the migration service license is installed on the platform and that you have sufficient license capacity.
  • Prepare the migration service installation package in advance.
  • Ensure that an image storage is added to the platform and that the image storage has sufficient storage space.

Procedure

  1. In the navigation pane, select Operations Management > Migration Service.
  2. On the Migration Service page, click Upload.
  3. In the Upload Migration Service Package dialog, configure the following options:
    Option Description
    Upload By Select the method for uploading the installation package, including URL and local file. Interrupted local uploads can be resumed.
    Note:
    • The system automatically retries recoverable upload errors. If an upload is paused due to a network interruption and the page remains open, the upload resumes automatically after the network recovers.
    • If the browser retains permission to access the original local file after the page is refreshed or you sign in again, the system automatically resumes an upload that was paused due to an error. If the browser prompts you to allow access to previously selected files or folders, grant access as needed.
    • If the browser does not have permission to access the file or the permission has expired, the upload cannot resume automatically. Click Pending Uploads at the top of the page. In the Pending Upload Tasks panel, locate the task, click Select to Continue, and reselect the same local file.
    • A manually paused task does not resume automatically. In the task details, click Continue.
    • If the local file has been modified, moved, or deleted, the original upload task cannot resume. Start a new upload.
    • If an upload error occurs, the platform automatically retries the upload up to five times. If all five retry attempts fail, the upload task enters the Failed state and cannot be resumed. Start a new upload.
    • Click View Upload History to view local file upload tasks.
    URL/Installation Package Enter a URL or upload the installation package file.
    Storage Path Specify a directory path to store the uploaded installation package and its decompressed files.
    Note:
    • Ensure that the directory has sufficient available space. Otherwise, the installation fails.
    • Do not use system directories such as /, /dev, /proc, /sys, /usr/bin, /bin, or /opt. Using these directories might cause server issues.
  4. Review the configuration and click OK.

Step 2: Deploy the Migration Service

Select the appropriate specification based on your business requirements to deploy the migration service. Once deployed, you can use the migration service to migrate VMs to the target platform.

Procedure

  1. On the Migration Service page, click Install.
  2. In the Deploy Migration Service dialog, configure the following options:
    Option Description
    Migration Service Version Displays the version of the service to be installed and deployed.
    Data Center The migration service is deployed as a data gateway VM. Select a data center.
    Run Location Select where the service runs.
    CPU The default is 8 cores. Set the number of CPU cores.
    Memory The default is 8 GB. Set the memory size.
    Storage Location Specify the data storage.
    Storage Pool When the storage location is distributed storage, specify a storage pool.
    Hard Disk 1 The default is 100 GB. Set the system disk size.
    Migration Network Specify a distributed port group to use as the migration network. Ensure that the selected distributed port group has network connectivity with both the source and target platforms.
    IPv4 Address Specify an IP address.
    Note: The IP address allocation method depends on the configuration of the selected migration network:
    • When DHCP is enabled on the migration network, the system automatically assigns an IP address.
    • When DHCP is disabled on the migration network, you need to specify an IP address.
    • When IPAM is enabled on the migration network, manually specified IP address must be within the selected network segment.
  3. Review the configuration and click OK.

Upgrade the Migration Service

Before you begin

  • Ensure that no migration tasks are in progress. Otherwise, you cannot upgrade the migration service.
  • Ensure that the image storage has sufficient storage space before you upload the migration service upgrade package.

Procedure

  1. In the navigation pane, select Operations Management > Migration Service > Migration Overview.
  2. On the Migration Overview page, click Upgrade.
  3. In the Upgrade Migration Service dialog, configure the following options:
    Option Description
    Migration Service Version Displays the currently deployed service version.
    Upload Method Select the method for uploading the installation package, including URL and local upload. Interrupted local uploads can be resumed.
    Note:
    • The system automatically retries recoverable upload errors. If an upload is paused due to a network interruption and the page remains open, the upload resumes automatically after the network recovers.
    • If the browser retains permission to access the original local file after the page is refreshed or you sign in again, the system automatically resumes an upload that was paused due to an error. If the browser prompts you to allow access to previously selected files or folders, grant access as needed.
    • If the browser does not have permission to access the file or the permission has expired, the upload cannot resume automatically. Click Pending Uploads at the top of the page. In the Pending Upload Tasks panel, locate the task, click Select to Continue, and reselect the same local file.
    • A manually paused task does not resume automatically. In the task details, click Continue.
    • If the local file has been modified, moved, or deleted, the original upload task cannot resume. Start a new upload.
    • If an upload error occurs, the platform automatically retries the upload up to five times. If all five retry attempts fail, the upload task enters the Failed state and cannot be resumed. Start a new upload.
    • Click View Upload History to view local file upload tasks.
    URL/Installation Package Enter a URL or upload the installation package file.
    Storage Path Specify a directory path to store the uploaded upgrade package and its decompressed files.
    Note:
    • Ensure that the directory has sufficient available space. Otherwise, the installation fails.
    • Do not use system directories such as /, /dev, /proc, /sys, /usr/bin, /bin, or /opt. Using these directories might cause server issues.
  4. Click OK.

What to do next

If the upgrade fails, you can upgrade again. You can use the existing upgrade package or upload a new one.

Enable or Disable the Migration Service

Before you begin

Ensure that no migration tasks are in progress. Otherwise, you cannot disable the migration service.

Procedure

  1. In the navigation pane, select Operations Management > Migration Service > Service Management.
  2. On the Service Management page, select the target migration service, and then click Actions > Enable/Disable.
    After you disable the migration service, all migration service-related features will become unavailable. Proceed with caution.

Delete the Migration Service

Before you begin

  • Ensure that no migration tasks are in progress. Otherwise, you cannot delete the migration service.
  • You can delete the migration service only when it is disabled.

Procedure

  1. In the navigation pane, select Operations Management > Migration Service > Service Management.
  2. On the Service Management page, select the target migration service, and then click Actions > Delete.
    Note: After deletion, the system will permanently remove all migration service files and configurations, and immediately release the CPU, memory, and IP address resources. Proceed with caution.
  3. After you read and confirm the risk information, click OK.

Add a Source Platform

Procedure

  1. In the navigation pane, select Operations Management > Migration Resource > Source Platform.
  2. On the Source Platform page, click Add Source Platform.
  3. In the Add Source Platform dialog, configure the following options:
    Option Description
    Name Set a name for the source platform.
    Data Gateway Configuration Method Select the configuration method. You can select an existing data gateway or enter the IP address of a new data gateway.
    Data Gateway Select a data gateway.
    Platform Type VMware.
    vCenter/ESXi Address Enter the address of the VMware environment.
    Username Enter the login username.
    Password Enter the password for the username.
    Connectivity Test Click Test to verify network connectivity.
  4. Review the configuration and click OK.

Delete a Source Platform

Before you begin

Ensure that no migration tasks are in progress. Otherwise, you cannot delete the source platform.

Procedure

  1. In the navigation pane, select Operations Management > Migration Resource > Source Platform.
  2. On the Source Platform page, select the target source platform, and then click Actions > Delete.
  3. Click OK.

Add a Data Gateway

Procedure

  1. In the navigation pane, select Operations Management > Migration Resource > Data Gateway.
  2. On the Data Gateway page, click Add Data Gateway.
  3. In the Add Data Gateway dialog, configure the following options:
    Option Description
    Name Set a name for the data gateway.
    Addition Method Select how to add the data gateway. You can create a new VM or use an existing IP address.

    If you select New Virtual Machine, configure the following parameters:

    Option Description
    Data Center Select the data center where the VM resides.
    Location Select where the VM runs.
    CPU The default is 8 cores. Set the number of CPU cores.
    Memory The default is 8 GB. Set the memory size.
    Storage Location Specify the data storage.
    Disk 1 The default is 100 GB. Set the system disk size.
    Network Specify a distributed port group. Ensure that the selected distributed port group has network connectivity with both the source and target platforms to support data transfer.
    IPv4 Address Specify an IP address.
    Note: The IP address allocation method depends on the configuration of the selected migration network:
    • When DHCP is enabled on the migration network, the system automatically assigns an IP address.
    • When DHCP is not enabled on the migration network, you must manually specify an IP address.
    • When IP address management is enabled on the migration network, if you manually specify an IP address, ensure that the address is within the selected network segment.

    If you select Existing IP, configure the following parameters:

    Option Description
    IP Address Enter an IP address.
    Host Name After the IP address is reachable, the corresponding host name is retrieved automatically.
    Connectivity Check Click Check to verify network connectivity.
  4. Review the configuration and click OK.

Delete a Data Gateway

Before you begin

Ensure that no ongoing migration tasks are associated with the data gateway. Otherwise, you cannot delete the data gateway.

Procedure

  1. In the navigation pane, select Operations Management > Migration Resource > Data Gateway.
  2. On the Data Gateway page, select the target data gateway, and then click Actions > Delete.
  3. After you read and confirm the risk information, click OK.

Create a Migration Task

Before you begin

Ensure that you have sufficient license capacity for the migration service.

Procedure

  1. In the navigation pane, select Operations Management > Migration Task > All Tasks.
  2. On the All Tasks page, click Create Migration Task.
  3. In the Create Migration Task dialog, configure the source platform:
    Option Description
    Source Platform Select the source platform.
    Source VM Add the source VM that you want to migrate.
    Note: The disk capacity of the source VM cannot exceed the limit defined by the license type. Additional capacity requires a separate license.
    • Trial License: Disk capacity limit is 1 TB.
    • Production License: Disk capacity limit is 5 TB.
    Migration Authorization Type Select the license type.
  4. Click Next.
  5. Configure the target platform.
    1. Complete the VM configuration:
      Option Description
      Data Center Select the data center where the VM will reside after migration.
      Cluster Select the cluster where the VM will reside after migration.
      Host Select the host where the VM will reside after migration.
      Storage Location Select the data storage that the VM will use after migration.
      Bus Type Select the bus type for the VM disk device.
      CPU Mode Select the CPU mode for the VM after migration.
      Destination Network Port Group Select the distributed port group that the VM will use.
      Temporary Network Port Group When you select Clone Network Configuration, you must configure a temporary network port group. A DHCP-enabled port group is recommended. By default, the target network port group is used. If the target port group does not have DHCP enabled, you must manually assign a temporary IP address.
      Security Group Select a security group.

      When you configure Destination Network Port Group, use the following options:

      Option Description
      CIDR Select the CIDR.
      Network Adapter Configuration Select whether to clone the source VM's network configuration and MAC address.
      • Clone Network Configuration: After cloning, the target VM retains the same IP address as the source VM by default. Enter the netmask and gateway manually.
      • Clone MAC Address: The target VM retains the same MAC address as the source VM.
      Note:
      • When you select Clone Network Configuration, the platform assigns a temporary IP address to the VM based on network properties to ensure data synchronization. You can also manually specify an IP address on the VM configuration confirmation page.
      • When you select Clone Network Configuration, power off the source VM before the formal cutover to avoid IP address conflicts.
      Destination IP Address Specify the destination IP address for the VM.
    2. Complete the cutover configuration by referring to the following example:
      Option Description
      Immediate Cutover When enabled, the system automatically performs cutover after the initial data synchronization is complete.
      Create Rollback Snapshot When enabled, the system creates a rollback snapshot for the target VM when cutover starts.

      Purpose of the rollback snapshot:

      • When enabled: If you select "Delete cutover program only" when deleting the migration task, the system automatically rolls back the target VM or disk to the snapshot state.
      • When disabled: The "Delete cutover program only" option will not be available when deleting the migration task.
      Auto Shut Down Source VM When enabled, the system shuts down the source VM before cutover.
      Auto Install VMTools When enabled, the system automatically installs VMTools after the target VM operating system is converted.
  6. Click Next.
  7. Review the configuration and click OK.

Synchronize a Migration Task

Before you begin

Ensure that the migration task status is "Synchronization Stopped", "Synchronization Failed", or "Ready for Cutover". Otherwise, you cannot perform the synchronization operation.

Procedure

  1. In the navigation pane, select Operations Management > Migration Task > All Tasks.
  2. On the All Tasks page, select the migration task that you want to synchronize, and then click Actions > Synchronize.
  3. In the Synchronize Migration Task dialog, select the synchronization mode.
    The following two synchronization modes are supported:
    • Incremental Sync: Only synchronizes data that has changed since the last synchronization.
    • Full Sync: Synchronizes all data of the VM. For migration tasks that have completed initial synchronization, the system performs a comparison scan before executing a full sync. This process may take a significant amount of time.
  4. Click OK.

Create a Test VM

Before you begin

Ensure that the migration task status is not "Cutover in Progress". Otherwise, you cannot create a test VM.

Procedure

  1. In the navigation pane, select Operations Management > Migration Task > All Tasks.
  2. On the All Tasks page, select the target migration task, and then click Actions > Test > Create Test Virtual Machine.
  3. In the Create Test Virtual Machine dialog, configure the following options:
    Option Description
    CPU Set the number of CPU cores for the VM.
    Memory Set the memory size for the VM.
    Network Select the distributed port group that the VM will use.
    CIDR The system retrieves the CIDR based on the selected network.
    IPv4 Address The IP address allocation method depends on the selected network configuration.
    • If DHCP is enabled on the selected distributed port group, an IPv4 address is automatically assigned by default. You can also manually specify an IP address, and the specified IP address must be within the CIDR.
    • If DHCP is not enabled on the selected distributed port group, you must manually specify an IP address, and the specified IP address must be within the CIDR.
    • If IPAM is not enabled on the selected distributed port group, the CIDR parameter is not displayed. You must manually specify an IP address.
    System Conversion Policy Specify the system conversion policy to apply before the VM starts.
    Data Recovery Point Use a snapshot or copy from a specific point in time to test VM recovery.

    When you configure System Conversion Policy, select one of the following options:

    Option Description
    Perform System Conversion Performs a full system conversion, including: driver replacement/injection, network adapter name and IP address configuration for the target VM, and post-script execution.
    Perform System Conversion Without Loading Target Drivers Skips driver replacement. Only configures the target VM's network adapter name and IP address, and executes post-scripts.
    Skip System Conversion No driver replacement, no network configuration (adapter name/IP address), and no post-script execution. You will need to log in to the target VM and manually perform these configurations.
  4. Review the configuration and click OK.

Perform Cutover

Before you begin

Ensure that the migration task status is "Ready for Cutover". Otherwise, you cannot perform the cutover operation.

Procedure

  1. In the navigation pane, select Operations Management > Migration Task > All Tasks.
  2. On the All Tasks page, select the target migration task, and then click Actions > Cutover.
    After cutover starts, VM workloads switch to the target platform. If Auto Shut Down Source VM is enabled for the migration task, the system shuts down the source VM by using the selected shutdown method.
  3. After you read and confirm the risk information, click OK.

Delete a Migration Task

Before you begin

  • When you delete multiple migration tasks, you can directly delete migration tasks whose status is "Synchronizing", "Synchronization Stopped", "Synchronization Failed", or "Ready for Cutover".
  • When you delete multiple migration tasks, for migration tasks whose status is "Cutover in Progress", "Cutover Successful", or "Cutover Failed", you can select a deletion policy as needed.

Procedure

  1. In the navigation pane, select Operations Management > Migration Task > All Tasks.
  2. On the All Tasks page, select the target migration task, and then click Actions > Delete.
  3. In the Deletion Policy dialog, select a deletion policy.
    Option Description
    Retain target Instance and Delete Migration Task Deletes only the migration task record and retains the target VM. You can reconfigure the source VM and create a new migration task later. This operation does not cause data or state loss, but you must manage the target VM yourself.
    Delete target Instance and Delete Migration Task Deletes the migration task record and its associated target VM. You can reconfigure the source VM and create a new migration task later.
    Delete Cutover Program Only Removes only the cutover program. This policy is available only when "Create Rollback Snapshot" is enabled. The system automatically rolls back the target VM to the state before cutover, and all changes made after cutover are lost. This operation is irreversible. Use with caution.
  4. Click OK.
  5. After you read and confirm the risk warning, click OK.