From ef276350be026e1fa40296cce158e142799ffff2 Mon Sep 17 00:00:00 2001 From: "vault-token-factory-spectrocloud[bot]" <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Date: Thu, 2 Jan 2025 10:52:43 +0000 Subject: [PATCH] docs: updates for VM Migration Assistant v1.0.5 (#5113) (#5199) * docs: updates for VM Migration Assistant v1.0.5 * ci: auto-formatting prettier issues * Apply suggestions from code review * ci: auto-formatting prettier issues * docs: code review suggestions Co-authored-by: Romain Decker * ci: auto-formatting prettier issues * docs: final amendments from review * docs: remove ableist terms --------- Co-authored-by: benradstone Co-authored-by: Romain Decker (cherry picked from commit 13397b9ca15753f4b598f3aa5b7a3c7d8b9d84de) Co-authored-by: Ben Radstone <56587332+benradstone@users.noreply.github.com> --- .../additional-configuration.md | 13 ++--- .../create-migration-plans.md | 53 ++++++++++++++++--- .../create-source-providers.md | 3 +- 3 files changed, 54 insertions(+), 15 deletions(-) diff --git a/docs/docs-content/vm-management/vm-migration-assistant/additional-configuration.md b/docs/docs-content/vm-management/vm-migration-assistant/additional-configuration.md index 54d95ed4e7..34cb4e2780 100644 --- a/docs/docs-content/vm-management/vm-migration-assistant/additional-configuration.md +++ b/docs/docs-content/vm-management/vm-migration-assistant/additional-configuration.md @@ -77,11 +77,12 @@ The **Details** tab has configurable settings for the provider. The configurable settings are described in the following table. These were originally defined when you performed the steps in [Create Source Providers](./create-source-providers.md). -| Setting | Description | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **URL** | Your vSphere / ESXi API endpoint for the SDK. You can specify a Full Qualified Domain Name (FQDN) or an IP address. For example, `https://vcenter.mycompany.com/sdk`. | -| **External web UI link** | Your vSphere / ESXi UI endpoint. You can specify a Full Qualified Domain Name (FQDN) or an IP address. For example, `https://vcenter.mycompany.com/ui`. | -| **VDDK init image** | Provide the registry URL to the VMware Virtual Disk Development Kit (VDDK) image. If providing an image, make sure you specify the registry URL without the HTTP scheme `https://` or `http://`. For example, `docker.io/myorganization/vddk:v8.0.3`. | +| Setting | Description | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **URL** | Your vSphere / ESXi API endpoint for the SDK. You can specify a Full Qualified Domain Name (FQDN) or an IP address. For example, `https://vcenter.mycompany.com/sdk`. | +| **External web UI link** | Your vSphere / ESXi UI endpoint. You can specify a Full Qualified Domain Name (FQDN) or an IP address. For example, `https://vcenter.mycompany.com/ui`. | +| **Convert Disk** | When enabled, disk conversion is handled using `virt-v2v`. For example, if you're migrating from VMware to Virtual Machine Orchestrator (VMO), `virt-v2v` can convert Virtual Machine Disk (VMDK) to raw or QEMU copy-on-write version 2 (qcow2) formats that are optimal for the target environment. | +| **VDDK init image** | Provide the registry URL to the VMware Virtual Disk Development Kit (VDDK) image. If providing an image, make sure you specify the registry URL without the HTTP scheme `https://` or `http://`. For example, `docker.io/myorganization/vddk:v8.0.3`. | Perform the following steps to change a setting. @@ -205,7 +206,7 @@ the steps in [Create Migration Plans](./create-migration-plans.md). | Setting | Description | | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Warm migration** | Choose whether this will be a warm or cold migration. A cold migration is when VMs are shut down at the start of migration. A warm migration is when VMs are shut down during the final switchover. | -| **Target namespace** | The target namespace for the migrated VMs. | +| **Target namespace** | The target namespace is where the migrated VMs will be located on your VMO cluster. | | **Disk decryption passphrases** | Provide a list of passphrases for [LUKS-encrypted devices](https://docs.fedoraproject.org/en-US/quick-docs/encrypting-drives-using-LUKS/#_encrypting_block_devices_using_dm_cryptluks) on the VMs you intend to migrate. | | **Transfer Network** | Change the migration transfer network for this plan. If a migration transfer network is defined for the source provider and exists in the target namespace, it is used by default. Otherwise, the pod network is used. | | **Preserve static IPs** | Choose whether to preserve the static IPs of the VMs migrated from vSphere. | diff --git a/docs/docs-content/vm-management/vm-migration-assistant/create-migration-plans.md b/docs/docs-content/vm-management/vm-migration-assistant/create-migration-plans.md index 4955102615..1df2aea81f 100644 --- a/docs/docs-content/vm-management/vm-migration-assistant/create-migration-plans.md +++ b/docs/docs-content/vm-management/vm-migration-assistant/create-migration-plans.md @@ -20,7 +20,8 @@ Follow this guide to create migration plans using the VM Migration Assistant. - At least one source provider for the VMs to be migrated. Refer to [Create Source Providers](./create-source-providers.md) for guidance. -- A healthy VMO cluster. Refer to the [Create a VMO Profile](../create-vmo-profile.md) for further guidance. +- A healthy Virtual Machine Orchestrator (VMO) cluster. Refer to the [Create a VMO Profile](../create-vmo-profile.md) + for further guidance. - The VMO cluster must have network connectivity to vCenter and ESXi hosts, and the VMs you want to migrate. @@ -179,6 +180,7 @@ Follow this guide to create migration plans using the VM Migration Assistant. qemu-guest-agent) echo "qemu-guest-agent" ;; virtio-tools) echo "virtio-win" ;; open-vm-tools) echo "open-vm-tools" ;; + cloud-init) echo "cloud-init" ;; *) echo "$generic_name" ;; esac ;; @@ -187,6 +189,7 @@ Follow this guide to create migration plans using the VM Migration Assistant. qemu-guest-agent) echo "qemu-guest-agent" ;; virtio-tools) echo "virtio-win" ;; open-vm-tools) echo "open-vm-tools" ;; + cloud-init) echo "cloud-init" ;; *) echo "$generic_name" ;; esac ;; @@ -195,6 +198,7 @@ Follow this guide to create migration plans using the VM Migration Assistant. qemu-guest-agent) echo "qemu-guest-agent" ;; virtio-tools) echo "virtio-drivers" ;; open-vm-tools) echo "open-vm-tools" ;; + cloud-init) echo "cloud-init" ;; *) echo "$generic_name" ;; esac ;; @@ -203,6 +207,7 @@ Follow this guide to create migration plans using the VM Migration Assistant. qemu-guest-agent) echo "qemu-guest-agent" ;; virtio-tools) echo "linux-virtio" ;; open-vm-tools) echo "open-vm-tools" ;; + cloud-init) echo "cloud-init" ;; *) echo "$generic_name" ;; esac ;; @@ -319,6 +324,34 @@ Follow this guide to create migration plans using the VM Migration Assistant. fi } + # Function to handle Cloud-init + handle_cloud_init() { + local package=$(get_package_name "cloud-init") + if is_installed "$package"; then + log "Cloud-init is already installed." + if [ "$DRYRUN" = false ]; then + if systemctl is-active --quiet cloud-init; then + log "Cloud-init service is running." + else + log "Starting Cloud-init service..." + systemctl start cloud-init || log "Failed to start Cloud-init service" + fi + else + log "Dry run: Would check and potentially start Cloud-init service" + fi + else + log "Cloud-init is not installed. Installing..." + if install_package "$package"; then + if [ "$DRYRUN" = false ]; then + log "Starting Cloud-init service..." + systemctl start cloud-init || log "Failed to start Cloud-init service" + else + log "Dry run: Would start Cloud-init service" + fi + fi + fi + } + # Function to check if running in a virtual environment check_virtual_env() { if [ -d /proc/vz ]; then @@ -400,6 +433,9 @@ Follow this guide to create migration plans using the VM Migration Assistant. log "Handling VMware Tools daemon (vmtoolsd)..." handle_vmtoolsd + log "Handling Cloud-init..." + handle_cloud_init + log "All tasks completed." } @@ -508,13 +544,14 @@ Follow this guide to create migration plans using the VM Migration Assistant. 8. Fill in the migration plan details. - | Setting | Description | Example | - | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | - | **Plan name** | A unique name for your migration plan. | `myMigrationPlan` | - | **Target provider** | Select the target provider from the drop-down Menu. By default, this will be your host cluster. | `host` | - | **Target namespace** | Select the target namespace for the VM migration from the drop-down Menu. | `myVmMigrationNamespace` | - | **Network map** | A storage map defines the mapping of source storage domains to target storage classes or datastores, ensuring VM disks are correctly placed in the destination environment. Adjust the mapping, or leave the default mapping in place. | `VM Network` / `Pod Networking` | - | **Storage map** | A network map defines the mapping of source networks to target networks, ensuring VM network interfaces are correctly connected in the destination environment. Adjust the mapping, or leave the default mapping in place. | `vsanDatastore` / `spectro-storage-class` | + | Setting | Description | Example | + | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | + | **Plan name** | A unique name for your migration plan. | `myMigrationPlan` | + | **Target provider** | Select the target provider from the drop-down Menu. By default, this will be your VMO cluster. | `host` | + | **Target namespace** | Select the target namespace from the drop-down Menu. The target namespace is where the migrated VMs will be located on your VMO cluster. | `myVmMigrationNamespace` | + | **Network map** | A network map defines the mapping of source networks to target networks, ensuring VM network interfaces are correctly connected in the destination environment. Adjust the mapping, or leave the default mapping in place. | `VM Network` / `Pod Networking` | + | **Storage map** | A storage map defines the mapping of source storage domains to target storage classes or datastores, ensuring VM disks are correctly placed in the destination environment. Adjust the mapping, or leave the default mapping in place. | `vsanDatastore` / `spectro-storage-class` | + | **Preserve static IPs** | Choose whether to preserve the static IPs of the VMs migrated from vSphere. | :white_check_mark: | 9. Click **Create migration plan**. The **Details** tab for the plan is then displayed. diff --git a/docs/docs-content/vm-management/vm-migration-assistant/create-source-providers.md b/docs/docs-content/vm-management/vm-migration-assistant/create-source-providers.md index 4e8cc02010..231df373d9 100644 --- a/docs/docs-content/vm-management/vm-migration-assistant/create-source-providers.md +++ b/docs/docs-content/vm-management/vm-migration-assistant/create-source-providers.md @@ -23,7 +23,7 @@ Machines (VMs) that need to be migrated. - The pack must be added to your cluster profile. Refer to [Create a VM Migration Assistant Cluster Profile](./create-vm-migration-assistant-profile.md) for guidance. - The VM Migration Assistant service console must be accessible from a web browser. -- A healthy VMO cluster. Refer to the [Create a VMO Profile](../create-vmo-profile.md) for further guidance. +- A healthy Virtual Machine Orchestrator (VMO) cluster. Refer to the [Create a VMO Profile](../create-vmo-profile.md) for further guidance. - The VMO cluster must have network connectivity to vCenter and ESXi hosts, and the VMs you want to migrate. @@ -224,6 +224,7 @@ Machines (VMs) that need to be migrated. | **Password** | Your vSphere / ESXi account password. | | **Skip certificate validation** | Enabling this option bypasses x509 CA verification. In production environments, do not enable if you are using a custom registry with self-signed SSL certificates, as the certificate can be provided in the next setting. | | **CA certificate** | Upload or drag and drop the CA certificate for your vSphere / ESXi. You can also use the **Fetch certificate from URL** option if your CA certificate is not third party or self-managed. | + | **Convert Disk** | When enabled, disk conversion is handled using virt-v2v. For example, if you're migrating from VMware vSphere to VMO, virt-v2v can convert Virtual Machine Disk (VMDK) to raw or QEMU copy-on-write version 2 (qcow2) formats that are optimal for the target environment. | 7. Click **Create Provider**. The provider details are then shown.