Skip to content

MTV-5019: Preparing the MTV repo for AEM/DITA migration #897

Merged
RichardHoch merged 1 commit into
kubev2v:mainfrom
RichardHoch:MTV-5019_clean_up
May 20, 2026
Merged

MTV-5019: Preparing the MTV repo for AEM/DITA migration #897
RichardHoch merged 1 commit into
kubev2v:mainfrom
RichardHoch:MTV-5019_clean_up

Conversation

@RichardHoch

@RichardHoch RichardHoch commented Apr 14, 2026

Copy link
Copy Markdown
Collaborator

Resolves https://redhat.atlassian.net/browse/MTV-5019 by verifying that the described errors exist and fixing the ones that do. The Jira referred to a number of extra periods (.) in the text, but I could not find them in the Asciidoc files.

Previews:

Summary by CodeRabbit

Documentation

  • Documentation
    • Standardized vendor credential tables for storage copy offload procedures, improving clarity and consistency across CLI and UI
    • Enhanced troubleshooting guidance for vSAN migrations requiring VDDK
    • Clarified migration planning concepts and provider mapping
    • Improved UI navigation steps for accessing migration logs
    • Enhanced clarity on migration plan actions and cutover options for warm migrations
    • Updated terminology consistency throughout documentation

Review Change Stack

@vercel

vercel Bot commented Apr 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
forklift-documentation Ready Ready Preview, Comment May 20, 2026 1:50pm

@coderabbitai

coderabbitai Bot commented May 5, 2026

Copy link
Copy Markdown

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Documentation refinements across the Migration Toolkit for Virtualization (MTV) guide: standardize VMware branding with the {vmw} placeholder, clarify VDDK requirements for vSAN and warm migrations, refactor storage vendor credential tables into unified formats for CLI and UI procedures, and streamline migration concept terminology and execution workflows.

Changes

Documentation Updates

Layer / File(s) Summary
VMware placeholder standardization
documentation/modules/common-attributes.adoc
The subtitle-migrating attribute now uses {vmw} instead of hardcoded "VMware" for consistent branding throughout the documentation.
VDDK documentation and link updates
documentation/doc-Planning_your_migration/assemblies/assembly_migrating-vms-web-console.adoc, documentation/modules/proc_adding-source-provider.adoc, documentation/modules/ref_new-features-and-enhancements-2-11.adoc
VDDK cross-reference link label changes from "VMware Virtual Disk Development Kit (VDDK)" to "Creating a VDDK image"; VDDK option text and feature release notes updated to use {vmw} placeholder and simplified kit name.
Migration planning concepts and terminology
documentation/modules/con_planning-intro.adoc, documentation/modules/con_about-mtv.adoc, documentation/modules/con_about-cold-warm-migration.adoc
MTV planning introduction reworded, migration type descriptions standardized to "shared storage," OVA validation note expanded for KVM images, cold/warm/live migration terminology refined, and outdated Technology Preview disclaimer removed.
VDDK requirement clarification for vSAN
documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc
Module abstract rewritten to explicitly state that VDDK is mandatory for VMware vSAN-backed VM migrations and migrations fail without a configured VDDK image.
OPA validation rules documentation
documentation/modules/con_about-rego-files.adoc
Rego policy file path updated from <provider> to _<provider>_ format and concerns hash formatting corrected in validation rule examples.
Migration execution: logs and plan options
documentation/modules/proc_running-migration-plan.adoc, documentation/modules/ref_migration-plan-options-ui.adoc
Log viewing procedure updated to match current MTV UI navigation (Virtual machines tab, PodsPod linksLogs); cutover option availability clarified to be active only for warm migrations.
Storage copy offload — CLI procedures
documentation/modules/proc_storage-copy-offload-cli.adoc
Vendor credential tables standardized with consistent Key/Description/Mandatory?/Default columns across all storage systems; new CLI section adds StorageMap custom resource example, vendor identifier mapping table, and instructions for configuring storage in migration plans.
Storage copy offload — UI procedures
documentation/modules/proc_storage-copy-offload-ui.adoc
Vendor credential table schema standardized to match CLI format; UI completion workflow steps added for creating ownerless storage maps using vSphere XCOPY Offload plugin and VMware vSphere migration plans via MTV wizard.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • anarnold97
  • solenoci

Poem

🐰 Tables align with freshened grace,
VMware's name finds its rightful place,
VDDK's role shines crystal clear,
From CLI flows to wizards dear—
Migration docs hop forward here! 🐾

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main objective—preparing the MTV documentation repository for AEM/DITA migration—which is confirmed by the PR description and all file changes being documentation-focused.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 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/about-rego-files.adoc`:
- Line 12: Replace the pseudo-hash `{“category”, “label”, “assessment”}` with
clear object/key wording in the sentence that describes what each `.rego` rule
adds to `concerns`: say that the rule "adds an object with `category`, `label`,
and `assessment` keys to the `concerns` array/key in the VM inventory record"
and keep the rest of the sentence about the web console and `<provider>`
inventory unchanged; update the paragraph in the documentation module
`about-rego-files.adoc` accordingly.

In `@documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc`:
- Line 12: Replace the hardcoded vendor name in the sentence "VDDK is mandatory
for migrations from VMware vSAN storage." by using the document attribute {vmw};
update the string to "VDDK is mandatory for migrations from {vmw} vSAN storage."
so the module consistently uses the {vmw} attribute (locate the sentence
containing "VDDK is mandatory for migrations from VMware vSAN storage.").

In `@documentation/modules/rn-2-11-0-resolved-issues.adoc`:
- Line 28: Replace the inconsistent link label
"link:https://issues.redhat.com/browse/MTV-3476[(MTV-3476)]" so it matches the
rest of the module's format by removing the parentheses around the ticket label,
i.e. change the trailing "[(MTV-3476)]" to "[MTV-3476]" so the link uses the
same bracketed label style as other entries.
🪄 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: ad0a0997-05fe-49ff-977b-642a4aba2669

📥 Commits

Reviewing files that changed from the base of the PR and between 0bc52d6 and b7681ee.

📒 Files selected for processing (14)
  • documentation/doc-Planning_your_migration/assemblies/assembly_migrating-vms-web-console.adoc
  • documentation/modules/about-cold-warm-migration.adoc
  • documentation/modules/about-mtv.adoc
  • documentation/modules/about-rego-files.adoc
  • documentation/modules/common-attributes.adoc
  • documentation/modules/con_migrating-vms-by-using-mtv-ui.adoc
  • documentation/modules/migration-plan-options-ui.adoc
  • documentation/modules/new-features-and-enhancements-2-11.adoc
  • documentation/modules/proc_adding-source-provider.adoc
  • documentation/modules/proc_storage-copy-offload-cli.adoc
  • documentation/modules/proc_storage-copy-offload-ui.adoc
  • documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc
  • documentation/modules/rn-2-11-0-resolved-issues.adoc
  • documentation/modules/running-migration-plan.adoc

Comment thread documentation/modules/about-rego-files.adoc Outdated
Comment thread documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc Outdated
Comment thread documentation/modules/rn-2-11-0-resolved-issues.adoc Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (1)
documentation/modules/about-rego-files.adoc (1)

12-12: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Replace pseudo-hash notation with clear object/key wording

Line 12 still uses {"category", "label", "assessment"}, which is not valid object notation and can confuse readers. Please reword this as an object with category, label, and assessment keys added to concerns.

Suggested fix
-Each validation rule is defined in a separate `.rego` file and tests for a specific condition. If the condition evaluates as `true`, the rule adds a `{"category", "label", "assessment"}` hash to the `concerns`. The `concerns` content is added to the `concerns` key in the inventory record of the virtual machine (VM). The web console displays the content of the `concerns` key for each VM in the `_<provider>_` inventory.
+Each validation rule is defined in a separate `.rego` file and tests for a specific condition. If the condition evaluates as `true`, the rule adds an object with `category`, `label`, and `assessment` keys to `concerns`. The `concerns` content is added to the `concerns` key in the inventory record of the virtual machine (VM). The web console displays the content of the `concerns` key for each VM in the `_<provider>_` inventory.
🤖 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/about-rego-files.adoc` at line 12, The sentence uses
invalid pseudo-hash notation {"category", "label", "assessment"}; update the
wording in the about-rego-files.adoc paragraph so it clearly describes adding an
object with keys category, label and assessment to the concerns (e.g., state
that a rule appends an object containing the category, label and assessment keys
to the concerns list), and keep the rest of the sentence about concerns being
stored in the concerns key of the VM inventory and displayed in the _<provider>_
inventory unchanged.
🤖 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.

Duplicate comments:
In `@documentation/modules/about-rego-files.adoc`:
- Line 12: The sentence uses invalid pseudo-hash notation {"category", "label",
"assessment"}; update the wording in the about-rego-files.adoc paragraph so it
clearly describes adding an object with keys category, label and assessment to
the concerns (e.g., state that a rule appends an object containing the category,
label and assessment keys to the concerns list), and keep the rest of the
sentence about concerns being stored in the concerns key of the VM inventory and
displayed in the _<provider>_ inventory unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ee912c50-9d03-4bb8-b484-f38e30269de9

📥 Commits

Reviewing files that changed from the base of the PR and between 2d6b6cb and 91079bd.

📒 Files selected for processing (3)
  • documentation/modules/about-rego-files.adoc
  • documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc
  • documentation/modules/running-migration-plan.adoc

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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/about-mtv.adoc`:
- Line 25: Update the sentence that begins "Live migration is available *_only_*
for migrations between {virt} clusters..." to mark live migration as a
Technology Preview feature: add a clear disclaimer after the feature statement
indicating it is Technology Preview (not covered by Red Hat production SLAs and
not recommended for production use) and preserve the version requirements
({project-short} 2.10+, {virt} 4.20+); ensure the wording mentions "Technology
Preview" explicitly and that it is unsupported for production.
🪄 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: edbab79a-cac4-4dae-9d33-8aa84c3b62a4

📥 Commits

Reviewing files that changed from the base of the PR and between 91079bd and a365847.

📒 Files selected for processing (14)
  • documentation/doc-Planning_your_migration/assemblies/assembly_migrating-vms-web-console.adoc
  • documentation/modules/about-cold-warm-migration.adoc
  • documentation/modules/about-mtv.adoc
  • documentation/modules/about-rego-files.adoc
  • documentation/modules/common-attributes.adoc
  • documentation/modules/con_migrating-vms-by-using-mtv-ui.adoc
  • documentation/modules/con_planning-intro.adoc
  • documentation/modules/migration-plan-options-ui.adoc
  • documentation/modules/new-features-and-enhancements-2-11.adoc
  • documentation/modules/proc_adding-source-provider.adoc
  • documentation/modules/proc_storage-copy-offload-cli.adoc
  • documentation/modules/proc_storage-copy-offload-ui.adoc
  • documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc
  • documentation/modules/running-migration-plan.adoc
✅ Files skipped from review due to trivial changes (11)
  • documentation/modules/proc_adding-source-provider.adoc
  • documentation/modules/common-attributes.adoc
  • documentation/doc-Planning_your_migration/assemblies/assembly_migrating-vms-web-console.adoc
  • documentation/modules/con_migrating-vms-by-using-mtv-ui.adoc
  • documentation/modules/migration-plan-options-ui.adoc
  • documentation/modules/about-cold-warm-migration.adoc
  • documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc
  • documentation/modules/new-features-and-enhancements-2-11.adoc
  • documentation/modules/proc_storage-copy-offload-ui.adoc
  • documentation/modules/con_planning-intro.adoc
  • documentation/modules/proc_storage-copy-offload-cli.adoc
🚧 Files skipped from review as they are similar to previous changes (2)
  • documentation/modules/about-rego-files.adoc
  • documentation/modules/running-migration-plan.adoc

Comment thread documentation/modules/con_about-mtv.adoc Outdated
Comment thread documentation/modules/con_about-cold-warm-migration.adoc Outdated
Comment thread documentation/modules/con_planning-intro.adoc Outdated
Signed-off-by: Richard Hoch <rhoch@redhat.com>
@RichardHoch RichardHoch merged commit bda3fde into kubev2v:main May 20, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants