WIP: MTV-3956: Add NetApp SHIFT zero-copy integration documentation for MTV 2.12#938
Draft
RichardHoch wants to merge 5 commits into
Draft
WIP: MTV-3956: Add NetApp SHIFT zero-copy integration documentation for MTV 2.12#938RichardHoch wants to merge 5 commits into
RichardHoch wants to merge 5 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughAdds a complete documentation suite for NetApp SHIFT zero-copy VMware migration integration. New modules cover the concept overview, two-phase workflow mechanics, prerequisites, PVC label/annotation requirements, UI and CLI migration procedures, and a troubleshooting guide. Existing assemblies and modules are updated to include the new content and redirect NFS/NetApp users away from storage copy offload. ChangesNetApp SHIFT Zero-Copy Integration Documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
documentation/modules/con_virt-v2v-in-place-netapp-shift.adoc (1)
27-27: ⚡ Quick winSME-TODO scope: warm-migration and pod-lifecycle uncertainty, consistent with con_how-netapp-shift-integration-works.adoc.
This module shares the same SME-TODO comment as con_how-netapp-shift-integration-works.adoc (line 27), indicating that warm-migration support and conversion-pod failure handling remain undocumented. Clarify before release whether these are future enhancements or explicitly unsupported features.
Would you like me to consolidate these shared TODOs into a single tracking item or draft a clarifying note for both modules?
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@documentation/modules/con_virt-v2v-in-place-netapp-shift.adoc` at line 27, The SME-TODO comment regarding warm-migration support and conversion-pod lifecycle with NetApp SHIFT is unclear and appears to be duplicated across multiple documentation modules. Resolve this by clarifying with the SME whether warm-migration and pod-lifecycle handling are future enhancements or explicitly unsupported features. Once clarified, either document the findings directly in the affected modules (replacing the TODO with actual documentation) or consolidate the duplicated TODOs into a single centralized tracking item to avoid ambiguity and ensure consistent information across all related documentation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@documentation/modules/proc_creating-form-based-storage-maps-ui-vmware.adoc`:
- Around line 42-43: The anchor reference in the NetApp SHIFT integration link
is incorrect. The link currently uses the anchor
`con_about-netapp-shift-integration_vmware`, but the target module defines the
ID as `netapp-shift-integration-overview_{context}`, which expands to
`netapp-shift-integration-overview_vmware` when context=vmware. Update the
anchor in the link from `#con_about-netapp-shift-integration_vmware` to
`#netapp-shift-integration-overview_vmware` to ensure the cross-reference
resolves correctly.
In `@documentation/modules/proc_netapp-shift-integration-steps.adoc`:
- Line 20: Replace the two SME-TODO comments with actual documentation links to
enable users to complete critical prerequisites before the NetApp SHIFT
migration. At line 20, replace the SME-TODO placeholder with a link to the
vSphere procedure for snapshot deletion and disk consolidation, and at line 24,
replace the SME-TODO placeholder with a link to the NetApp SHIFT procedure for
disk cloning and PVC creation. If internal documentation for these procedures
does not yet exist, cross-reference appropriate third-party NetApp or VMware
documentation as interim guidance to unblock users from proceeding through the
prerequisites and into the core Phase 1 SHIFT cloning operation.
---
Nitpick comments:
In `@documentation/modules/con_virt-v2v-in-place-netapp-shift.adoc`:
- Line 27: The SME-TODO comment regarding warm-migration support and
conversion-pod lifecycle with NetApp SHIFT is unclear and appears to be
duplicated across multiple documentation modules. Resolve this by clarifying
with the SME whether warm-migration and pod-lifecycle handling are future
enhancements or explicitly unsupported features. Once clarified, either document
the findings directly in the affected modules (replacing the TODO with actual
documentation) or consolidate the duplicated TODOs into a single centralized
tracking item to avoid ambiguity and ensure consistent information across all
related documentation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ca308a9e-884c-43ed-99d8-87844a14b3ad
📒 Files selected for processing (19)
documentation/doc-Migrating_your_virtual_machines/assemblies/assembly_migrating-from-vmware.adocdocumentation/doc-Migrating_your_virtual_machines/assemblies/assembly_troubleshooting-migration.adocdocumentation/doc-Migrating_your_virtual_machines/assemblies/assembly_understanding-mtv-migration.adocdocumentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-vmware.adocdocumentation/modules/con_about-netapp-shift-integration.adocdocumentation/modules/con_about-storage-copy-offload.adocdocumentation/modules/con_how-netapp-shift-integration-works.adocdocumentation/modules/con_mtv-workflow.adocdocumentation/modules/con_virt-v2v-in-place-netapp-shift.adocdocumentation/modules/con_virt-v2v-mtv.adocdocumentation/modules/proc_creating-form-based-storage-maps-ui-vmware.adocdocumentation/modules/proc_netapp-shift-integration-cli.adocdocumentation/modules/proc_netapp-shift-integration-steps.adocdocumentation/modules/proc_netapp-shift-integration-ui.adocdocumentation/modules/ref_netapp-shift-prerequisites.adocdocumentation/modules/ref_netapp-shift-pvc-requirements.adocdocumentation/modules/ref_sco-supported-storage-providers.adocdocumentation/modules/ref_troubleshooting-netapp-shift.adocdocumentation/modules/ref_troubleshooting-storage-copy-offload-netapp-issues.adoc
Comment on lines
+42
to
+43
|
|
||
| NetApp SHIFT zero-copy integration for NFS-backed storage does not use the *Offload plugin* options. You still create standard storage maps for the target storage class; NetApp SHIFT creates PVCs separately. Storage classes must be annotated in the {project-short} UI to indicate NetApp SHIFT capability. See link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.12/html/planning_your_migration_to_red_hat_openshift_virtualization/assembly_planning-migration-vmware_mtv#con_about-netapp-shift-integration_vmware[Migrating {vmw} virtual machines by using NetApp SHIFT zero-copy integration]. |
There was a problem hiding this comment.
Incorrect anchor reference in the NetApp SHIFT link.
Line 43 uses the anchor #con_about-netapp-shift-integration_vmware, but the target module con_about-netapp-shift-integration.adoc defines the ID as [id="netapp-shift-integration-overview_{context}"], which expands to netapp-shift-integration-overview_vmware when context=vmware. This will cause the link to fail.
🔗 Proposed fix for the anchor reference
-See link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.12/html/planning_your_migration_to_red_hat_openshift_virtualization/assembly_planning-migration-vmware_mtv#con_about-netapp-shift-integration_vmware[Migrating {vmw} virtual machines by using NetApp SHIFT zero-copy integration].
+See link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.12/html/planning_your_migration_to_red_hat_openshift_virtualization/assembly_planning-migration-vmware_mtv#netapp-shift-integration-overview_vmware[Migrating {vmw} virtual machines by using NetApp SHIFT zero-copy integration].🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@documentation/modules/proc_creating-form-based-storage-maps-ui-vmware.adoc`
around lines 42 - 43, The anchor reference in the NetApp SHIFT integration link
is incorrect. The link currently uses the anchor
`con_about-netapp-shift-integration_vmware`, but the target module defines the
ID as `netapp-shift-integration-overview_{context}`, which expands to
`netapp-shift-integration-overview_vmware` when context=vmware. Update the
anchor in the link from `#con_about-netapp-shift-integration_vmware` to
`#netapp-shift-integration-overview_vmware` to ensure the cross-reference
resolves correctly.
| + | ||
| In vSphere, delete all snapshots for the source VMs and consolidate disks to flatten the disk chain. VM disks must be flattened before migration due to proprietary VMware file formatting. | ||
| + | ||
| // SME-TODO: Add link to vSphere procedure for snapshot deletion and disk consolidation. |
There was a problem hiding this comment.
SME-TODOs for external procedure links—critical for step-by-step completeness.
Lines 20 and 24 contain SME-TODOs referencing missing procedures:
- Line 20: vSphere snapshot deletion and disk consolidation procedure
- Line 24: NetApp SHIFT disk cloning and PVC creation procedure
These steps are described as critical prerequisites (VM disks "must be flattened" per ref_netapp-shift-prerequisites.adoc), but users lack documentation links to execute them. Step 3 (NetApp SHIFT cloning) is particularly critical—it is the core Phase 1 operation that users must complete before proceeding to MTV migration.
Ensure these external documentation links are resolved and verified before release, or consider cross-referencing third-party NetApp or VMware documentation as interim guidance.
Would you like me to help generate a consolidated list of missing external procedure links for SME/product owner follow-up?
Also applies to: 24-24
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@documentation/modules/proc_netapp-shift-integration-steps.adoc` at line 20,
Replace the two SME-TODO comments with actual documentation links to enable
users to complete critical prerequisites before the NetApp SHIFT migration. At
line 20, replace the SME-TODO placeholder with a link to the vSphere procedure
for snapshot deletion and disk consolidation, and at line 24, replace the
SME-TODO placeholder with a link to the NetApp SHIFT procedure for disk cloning
and PVC creation. If internal documentation for these procedures does not yet
exist, cross-reference appropriate third-party NetApp or VMware documentation as
interim guidance to unblock users from proceeding through the prerequisites and
into the core Phase 1 SHIFT cloning operation.
RichardHoch
changed the title
RichardHoch
commented
Jun 14, 2026
| Storage copy offload is a feature that allows you to migrate {vmw} virtual machines (VMs) that are in a storage array network (SAN) more efficiently. This feature makes use of the command `vmkfstools` on the ESXi host, which invokes the `XCOPY` command on the storage array using an Internet Small Computer Systems Interface (iSCSI) or Fibre Channel (FC) connection. Storage copy offload lets you copy data inside a SAN more efficiently than copying the data over a network. For {project-first} 2.11, storage copy offload is available as GA for cold migration and as a Technology Preview feature for warm migration. | ||
|
|
||
| For more information about storage copy offload, see link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.11/html/planning_your_migration_to_red_hat_openshift_virtualization/assembly_planning-migration-vmware_mtv#con_about-storage-copy-offload_vmware[Migrating {vmw} virtual machines by using storage copy offload]. | ||
|
|
Collaborator
Author
There was a problem hiding this comment.
Note to self -- this note needs to be moved and cut -- from the demo, looks like the target storage is labeled NetApp Shift. Still being verified.
The YAML file of the storage class indicates it's netApp Shift.
Requires Ontop NFS
This commit adds comprehensive documentation for the NetApp SHIFT zero-copy integration feature, which enables near-instantaneous migration of VMware VMs whose disks reside on NetApp NFS storage. New modules created: - con_about-netapp-shift-integration.adoc: Overview and comparison with storage copy offload - con_how-netapp-shift-integration-works.adoc: Technical details of the two-phase migration process - ref_netapp-shift-prerequisites.adoc: Prerequisites including Trident operator add-on and snapshot restrictions - ref_netapp-shift-pvc-requirements.adoc: PVC label and annotation requirements for NetApp SHIFT integration - proc_netapp-shift-integration-steps.adoc: Planning and execution workflow - proc_netapp-shift-integration-ui.adoc: UI-based migration procedure - proc_netapp-shift-integration-cli.adoc: CLI-based migration procedure - con_virt-v2v-in-place-netapp-shift.adoc: How MTV uses virt-v2v-in-place for NetApp SHIFT - ref_troubleshooting-netapp-shift.adoc: Troubleshooting guide for common NetApp SHIFT issues Assemblies updated: - assembly_planning-migration-vmware.adoc: Added NetApp SHIFT section - assembly_migrating-from-vmware.adoc: Added CLI procedure and PVC requirements reference - assembly_understanding-mtv-migration.adoc: Added virt-v2v-in-place concept - assembly_troubleshooting-migration.adoc: Added NetApp SHIFT troubleshooting reference Existing modules updated: - con_about-storage-copy-offload.adoc: Added note distinguishing NetApp SHIFT (NFS) from storage copy offload (block) - ref_sco-supported-storage-providers.adoc: Clarified NetApp ONTAP applies to block/XCOPY only - ref_troubleshooting-storage-copy-offload-netapp-issues.adoc: Added reference to NetApp SHIFT troubleshooting - con_virt-v2v-mtv.adoc: Added reference to virt-v2v-in-place usage - con_mtv-workflow.adoc: Updated workflow to mention NetApp SHIFT PVC detection - proc_creating-form-based-storage-maps-ui-vmware.adoc: Added note about NetApp SHIFT and storage class annotation Key features documented: - GA release status for MTV 2.12 - Cold migration only support - Zero-copy migration (1 TB in ~1 second demonstrated) - NetApp Trident CSI integration - Critical snapshot restriction requirement - Storage class annotation requirement Resolves: MTV-3956 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Moved all SME-TODO items from inline comments to clearly marked sections at the end of each module. This improves readability by separating SME review items from the module content while keeping them visible for tracking. Changes: - All inline SME-TODO comments removed from module text - Added '// SME-TODOs' section at end of affected modules - Numbered and organized TODO items for clarity Affected modules: - ref_netapp-shift-pvc-requirements.adoc (5 items) - ref_netapp-shift-prerequisites.adoc (4 items) - proc_netapp-shift-integration-steps.adoc (2 items) - proc_netapp-shift-integration-ui.adoc (3 items) - proc_netapp-shift-integration-cli.adoc (3 items) - con_virt-v2v-in-place-netapp-shift.adoc (1 item) - ref_troubleshooting-netapp-shift.adoc (3 items) Total: 21 SME-TODO items organized and tracked
RichardHoch
force-pushed
the
MTV-3956_NetApp-integration
branch
from
b9c10de to
9d53cc4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation for the NetApp SHIFT zero-copy integration feature for MTV 2.12, which enables near-instantaneous migration of VMware VMs whose disks reside on NetApp NFS storage.
What's New
New Documentation Modules (9 total)
Concept Modules
con_about-netapp-shift-integration.adoc- Overview and comparison with storage copy offloadcon_how-netapp-shift-integration-works.adoc- Technical details of two-phase migrationcon_virt-v2v-in-place-netapp-shift.adoc- How MTV uses virt-v2v-in-placeReference Modules
ref_netapp-shift-prerequisites.adoc- Prerequisites including Trident add-on and snapshot restrictionsref_netapp-shift-pvc-requirements.adoc- PVC label and annotation requirementsref_troubleshooting-netapp-shift.adoc- Troubleshooting common issuesProcedure Modules
proc_netapp-shift-integration-steps.adoc- Planning and execution workflowproc_netapp-shift-integration-ui.adoc- UI-based migration procedureproc_netapp-shift-integration-cli.adoc- CLI-based migration procedureUpdated Documentation (10 modules + 4 assemblies)
Assemblies
assembly_planning-migration-vmware.adoc- Added NetApp SHIFT sectionassembly_migrating-from-vmware.adoc- Added CLI procedure and PVC requirementsassembly_understanding-mtv-migration.adoc- Added virt-v2v-in-place conceptassembly_troubleshooting-migration.adoc- Added NetApp SHIFT troubleshootingExisting Modules
Key Documentation Points
SME Review Needed
The following items are marked with SME-TODO comments in the modules:
Testing
Related Issues
Resolves: MTV-3956
Documentation Source
Based on:
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation