Skip to main content
Version: latest

Create a VM Migration Assistant Profile

Follow these steps to create a new add-on profile that will be applied to your existing VMO cluster.

Prerequisites​

  • Your Palette account role must have the clusterProfile.create permission to create a cluster profile. Refer to the Permissions documentation for more information.
  • A healthy VMO cluster. Refer to the Create a VMO Profile for further guidance.
    • The VMO cluster must have network connectivity to vCenter and ESXi hosts, and the VMs you want to migrate.

Create the Profile​

  1. Log in to Palette.

  2. From the left Main Menu click Profiles.

  3. Click on the Add Cluster Profile button.

  4. Fill out the basic information and ensure you select Add-on for the type. Click on Next to continue.

  5. Select Add New Pack. In the next window that displays, enter Virtual Machine Migration Assistant in the Filter by name search bar. The pack is in the Spectro Addon Repo registry. Select the pack when it appears.

  6. Palette displays the YAML file in the editor on the right. You can edit the YAML as needed. Review the following service console parameters and adjust to your requirements as needed.

    ParameterDescriptionDefault Value
    vm-migration-assistant-ui.console.service.typeChoose how to expose the service console: NodePort / LoadBalancer / ClusterIP. Refer to Service type for guidance on Kubernetes service types."LoadBalancer"
    vm-migration-assistant-ui.console.service.loadBalancerPortChoose the external port to expose the service console when LoadBalancer is selected."443"
    vm-migration-assistant-ui.console.service.nodePortChoose the external port to expose the service console when nodePort is selected."30443"
    vm-migration-assistant-ui.console.deployment.env.userAuthIf you want to enable OIDC for the service console, set the value to oidc. The OIDC configuration is inherited from your Kubernetes pack configuration, and the service console only supports OIDC when Palette is configured as the Identity Provider. Refer to SAML and OIDC SSO for details.disabled
    vm-migration-assistant-ui.console.ingress.enabledChoose whether to enable Ingress access to the VM Migration Assistant service console. If enabled, the Ingress provides external connectivity to the service console. You can still access the service console through the cluster services list in Palette if vm-migration-assistant-ui.console.service.type is set to LoadBalancer or NodePort.false
    vm-migration-assistant-ui.console.ingress.hostSpecify the domain name that the Ingress resource will use to expose the VM Migration Assistant service console.
    vm-migration-assistant-ui.console.ingress.tlsIf providing your own TLS certificates, define the TLS configuration for the Ingress within this parameter. If you need to secure multiple domains or subdomains with different certificates, you can add multiple entries. Each array must contain the secretName, hosts, crt, and key parameters.
    vm-migration-assistant-ui.console.ingress.tls.secretNameThe name for the Kubernetes Secret where the TLS certificate and key will be stored.
    vm-migration-assistant-ui.console.ingress.tls.hostsOne or more hostnames that the certificate should secure.
    vm-migration-assistant-ui.console.ingress.tls.crtThe CA-issued TLS certificate.
    vm-migration-assistant-ui.console.ingress.tls.keyThe private key corresponding to the certificate.
    vm-migration-assistant-ui.console.ingress.selfSignedIssuer.enabledWhen set to true, cert-manager will automatically issue a self-signed TLS certificate based on the ingress.tls.hosts and ingress.tls.secretName values. This allows you to omit the manual certificate and key parameters being ingress.tls.crt and ingress.tls.key respectively.false

  7. Click on Confirm & Create.

  8. In the following screen, click Next.

  9. Click Finish Configuration.

  10. From the Main Menu, choose Clusters and select your VMO cluster.

  11. In the Profile tab, click Add add-on profile (+) and select the newly created profile. Click Confirm.

  12. Click Save to deploy the VM Migration Assistant to your cluster.

Validate​

  1. Log in to Palette.

  2. Navigate to Profiles from the left Main Menu.

  3. Locate the newly created profile in the list.

  4. From the left Main Menu, click Clusters and select your cluster.

  5. In the Overview tab, ensure that the cluster status and health is Running and Healthy.

  6. In the Overview tab, the Services list displays the vm-migration service with a clickable port. Click the port to access the VM Migration Assistant service console. The port number is based on your service console configuration.

Access the VM Migration Assistant Service Console​

You can access the service console based on how you configured the VM Migration Assistant YAML manifest when creating the cluster profile.

The following examples are for each console.service.type:

  • If you configured an Ingress with a domain of vm-migration.mycompany.dev, you can access the service console at https://vm-migration.mycompany.dev.

  • If you configured a NodePort with a nodePort of 30443, you can access the service console at https://<NODE_IP>:30443.

  • If you configured a LoadBalancer with a loadBalancerPort of 443, you can access the service console at https://<LOAD_BALANCER_IP>, where the load balancer IP address is provided by your load balancer solution (such as MetalLB).

Next Steps​

You can now use the VM Migration Assistant to migrate your VMs. Refer to the Create Source Providers guide to start creating your source providers.