Skip to content

Commit 1818a2f

Browse files
committed
updates
1 parent 4080aca commit 1818a2f

5 files changed

Lines changed: 67 additions & 31 deletions

documentation/modules/proc_adding-source-provider.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,8 @@ endif::[]
4444
ifdef::hyperv[]
4545
= Adding a Microsoft Hyper-V source provider
4646
47-
// SME REVIEW NEEDED: Should we add Prerequisites for SMB share setup and VM export process?
48-
4947
[role="_abstract"]
50-
You can add a Microsoft Hyper-V source provider by using the {ocp} web console. Hyper-V virtual machines are exported to an SMB share for migration.
48+
You can add a Microsoft Hyper-V source provider by using the {ocp} web console. The provider uses WinRM to connect to the Hyper-V host and reads VM disk files from a configured SMB share.
5149
5250
[NOTE]
5351
====
@@ -286,8 +284,8 @@ If you have Administrator privileges, you can see all projects, otherwise, you c
286284
.. *Provider details*
287285

288286
* *Provider resource name*: Name of the source provider.
289-
// SME REVIEW NEEDED: Does the UI safely escape backslashes, or should we recommend only forward-slash format?
290-
* *URL*: Path to the SMB share containing the Hyper-V exported VMs. For example, `//192.168.122.115/VMShare` or `\\192.168.122.115\VMShare`.
287+
* *URL*: The Hyper-V host address for WinRM connectivity, for example, `192.168.122.115` or `hyperv-host.example.com`.
288+
* *SMB share path*: Path to the SMB share that contains the VM disk files, for example, `//192.168.122.115/VMShare`.
291289
+
292290
The SMB share must be accessible from both the Hyper-V host and the {ocp-short} cluster.
293291

documentation/modules/proc_creating-plan-wizard-hyperv.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,7 @@ If you choose an existing map, be sure it has the same source provider and the s
100100
You can create an ownerless storage map, which you and others can use for additional migration plans, in the *Storage maps* section of the UI.
101101
====
102102
+
103-
// SME REVIEW NEEDED: Does the wizard auto-detect CSV/local paths? Should users verify auto-generated mappings?
104-
105-
** *Source storage*: Select from the list.
103+
** *Source storage*: Select the SMB share from the list.
106104
** *Target storage*: Select from the list.
107105
+
108106
If needed, click *Add mapping* to add another mapping.

documentation/modules/proc_migrating-vms-cli-hyperv.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ where:
4747
`ownerReferences`::
4848
Optional section for the provider's `name` and `uid`.
4949
+
50-
// SME REVIEW NEEDED: Do unquoted backslashes break YAML parsing? Should we recommend only forward-slash format?
5150
`<smb_server_path>`::
52-
The SMB share path in `//server/share` or `\\server\share` format (for example, `//192.168.122.115/VMShare`).
51+
The SMB share path in `//server/share` format, for example, `//192.168.122.115/VMShare`. Use forward slashes to avoid YAML parsing issues with unquoted backslashes.
5352
+
5453
`<smb_username>`::
5554
The username for the SMB share (for example, `Administrator` or `DOMAIN\username`).

documentation/modules/ref_compatibility-guidelines.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ You must install compatible software versions. The table that follows lists the
1616
|{project-version} |{ocp-y-version} |{ocp-y-version} |6.5 or later |4.4 SP1 or later|16.1 or later|Windows Server 2019 or later
1717
|===
1818

19-
// SME REVIEW NEEDED: Confirm supported Windows Server versions for Hyper-V - 2016, 2019, 2022, 2025?
20-
2119
[NOTE]
2220
====
2321
Migration from {rhv-full} 4.3

documentation/modules/ref_hyperv-prerequisites.adoc

Lines changed: 62 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,22 @@
66
[id="ref_hyperv-prerequisites_{context}"]
77
= Microsoft Hyper-V prerequisites
88

9-
// SME REVIEW NEEDED: This file needs technical details verified and added:
10-
// - How are VMs exported to the SMB share? (manual/automatic)
11-
// - Does MTV connect via WinRM or only SMB? Why no WinRM credentials in UI?
12-
// - What are the specific WinRM configuration commands and settings?
13-
// - What service account permissions are required? (Local Admin, Hyper-V Admin, or specific privileges)
14-
// - What are the specific SMB share permissions and configuration details?
15-
// - Are there additional network requirements or firewall rules beyond ports 5986 and 445?
16-
// - What are the scope/limitations? (Clustered Hyper-V? CSV? Gen1 vs Gen2 VMs? SCVMM?)
17-
189
[role="_abstract"]
19-
To migrate virtual machines from Microsoft Hyper-V to {virt}, you must configure an SMB share for VM exports, enable WinRM on the Hyper-V host, and ensure network connectivity. Review these requirements before creating a provider.
10+
To migrate virtual machines from Microsoft Hyper-V to {virt}, you must configure WinRM on the Hyper-V host, expose VM disk files on an SMB share, and ensure network connectivity. Review these requirements before creating a provider.
2011

2112
[NOTE]
2213
====
2314
{project-short} supports only cold migration from Microsoft Hyper-V. Warm migration is not available.
2415
====
2516

26-
The following prerequisites apply to Microsoft Hyper-V migrations:
17+
== Prerequisites
2718

2819
* You must use a xref:ref_compatibility-guidelines_{context}[compatible version] of Windows Server with Hyper-V.
2920
* You must configure Windows Remote Management (WinRM) on the Hyper-V host for HTTPS communication.
3021
* An SMB share must be available and accessible from both the Hyper-V host and the {ocp-short} cluster.
31-
* The service account used for authentication must have appropriate permissions to access the SMB share and manage Hyper-V virtual machines.
32-
* The target namespace must have network connectivity to the SMB share and the Hyper-V WinRM endpoint. NetworkPolicies that block egress connections from the target namespace prevent migration from succeeding.
22+
* VM disk files (VHD or VHDX) must be exposed on the SMB share before migration. {project-short} does not export VMs automatically.
23+
* The service account must be a member of the Hyper-V Administrators group and have read access to the SMB share. Local Administrator is the simplest option.
24+
* The target namespace must have network connectivity to both the SMB share and the Hyper-V WinRM endpoint. NetworkPolicies that block egress connections from the target namespace prevent migration from succeeding.
3325
* The VM operating system must be certified and supported for use as a link:https://access.redhat.com/articles/973163#ocpvirt[guest operating system with {virt}] _and_ for link:https://access.redhat.com/articles/1351473[conversion to KVM with `virt-v2v`].
3426
* A default `MigController` instance must be present. This instance is required for the Storage Migration option in the {ocp} web console in certain {ocp-name} versions. For steps to create the default `MigController` instance, see link:https://access.redhat.com/solutions/7136894[Storage Migration Option Missing for Virtual Machines in OpenShift 4.20 Despite Availability in 4.18].
3527

@@ -42,16 +34,67 @@ The following network ports must be accessible for Microsoft Hyper-V migrations:
4234
.Network ports
4335
|===
4436
|Port |Protocol |Description
45-
|5986 |TCP |WinRM HTTPS (default)
37+
|5986 |TCP |WinRM HTTPS
4638
|445 |TCP |SMB file sharing
4739
|===
4840

41+
[id="ref_hyperv-winrm-configuration_{context}"]
42+
== WinRM configuration
43+
44+
{project-short} connects to the Hyper-V host by using WinRM to discover VM metadata (disks, NICs, and other properties). You must configure WinRM for HTTPS communication on the Hyper-V host before creating the provider.
45+
46+
Quick configuration::
47+
Run the following command on the Windows host to configure WinRM with HTTPS:
48+
+
49+
[source,terminal]
50+
----
51+
winrm quickconfig -transport:https
52+
----
53+
54+
Manual configuration::
55+
Alternatively, configure WinRM manually by running the following PowerShell commands on the Windows host:
56+
+
57+
[source,terminal]
58+
----
59+
Enable-PSRemoting -Force
60+
61+
New-SelfSignedCertificate -DnsName "<hostname>" -CertStoreLocation Cert:\LocalMachine\My
62+
63+
winrm create winrm/config/Listener?Address=*+Transport=HTTPS '@{Hostname="<hostname>";CertificateThumbprint="<thumbprint>"}'
64+
65+
Set-Item WSMan:\localhost\Service\Auth\Basic -Value $true
66+
67+
New-NetFirewallRule -Name "WinRM-HTTPS" -DisplayName "WinRM HTTPS" -Protocol TCP -LocalPort 5986 -Action Allow
68+
----
69+
+
70+
Replace `<hostname>` with your Hyper-V host FQDN and `<thumbprint>` with the certificate thumbprint from the `New-SelfSignedCertificate` command output.
71+
4972
[id="ref_hyperv-smb-share_{context}"]
5073
== SMB share requirements
5174

52-
The SMB share must be configured with the following requirements:
75+
The SMB share provides access to VM disk files during migration. {project-short} reads VM disk files from the SMB share by using the SMB CSI driver.
76+
77+
* The share must be accessible by using the Linux SMB path format (`//server/share`).
78+
* The service account credentials must have read access to the SMB share. Write access is not required.
79+
* VM disk files (VHD or VHDX) must be accessible at the share path before migration begins.
80+
* The share must have sufficient storage space to hold the VM disk files.
81+
82+
[id="ref_hyperv-credentials_{context}"]
83+
== Credential requirements
84+
85+
The provider credentials are used for both WinRM connectivity and SMB share access by default. Dedicated SMB credentials can be specified in the CLI if the SMB share uses different authentication.
86+
87+
* The service account must be a member of the Hyper-V Administrators group at minimum.
88+
* The service account must have read access to the SMB share.
89+
* Local Administrator is the simplest option as it provides all necessary permissions.
90+
91+
[id="ref_hyperv-scope-limitations_{context}"]
92+
== Scope and limitations
5393

54-
* The share must be accessible using either Windows UNC path format (`\\server\share`) or Linux SMB path format (`//server/share`).
55-
* The service account credentials must have read and write access to the SMB share.
56-
* The share must have sufficient storage space to hold the exported Hyper-V virtual machine files.
57-
* The Hyper-V host must be able to export virtual machines to the share.
94+
* Generation 1 and Generation 2 VMs are both supported.
95+
* VHD and VHDX disk formats are both supported and automatically detected by file extension.
96+
* Cold migration only. Warm migration is not available.
97+
* VMs with checkpoints (snapshots) are flagged and may not migrate successfully.
98+
* System Center Virtual Machine Manager (SCVMM) integration is not supported.
99+
* Clustered Hyper-V environments are not supported.
100+
* Cluster Shared Volumes (CSV) are not explicitly handled. Only disks located on the SMB share are usable.

0 commit comments

Comments
 (0)