Skip to content

PVC name template CNV#932

Draft
Jenny-Anne wants to merge 2 commits into
kubev2v:mainfrom
Jenny-Anne:MTV-4264-pvc-name-template-cnv-cnv
Draft

PVC name template CNV#932
Jenny-Anne wants to merge 2 commits into
kubev2v:mainfrom
Jenny-Anne:MTV-4264-pvc-name-template-cnv-cnv

Conversation

@Jenny-Anne

@Jenny-Anne Jenny-Anne commented May 28, 2026

Copy link
Copy Markdown
Collaborator

Jira: https://redhat.atlassian.net/browse/MTV-4264

Preview:
PVC name template variables for OpenShift Virtualization-to-OpenShift Virtualization migrations: https://forklift-documentation-git-fork-je-1ff14e-yaacov-8047s-projects.vercel.app/downstream/documentation/doc-Planning_your_migration/master.html#ref_pvc-name-template-variables-cnv_cnv

Summary by CodeRabbit

  • Documentation
    • Added new reference documentation for PVC name template customization in virtual machine migrations.
    • Updated migration procedures to document pvcNameTemplate field for customizing PersistentVolumeClaim naming with template variables and examples.
    • Enhanced cross-references to template variable documentation for VMware migrations.

Review Change Stack

@vercel

vercel Bot commented May 28, 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 28, 2026 11:18am

@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@Jenny-Anne, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 23 minutes and 9 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 87e30e2e-c9f8-4231-8007-092a6cdfe871

📥 Commits

Reviewing files that changed from the base of the PR and between 8990186 and 574d46b.

📒 Files selected for processing (1)
  • documentation/modules/ref_pvc-name-template-variables-cnv.adoc
📝 Walkthrough

Walkthrough

This PR reorganizes Forklift migration documentation to decouple VMware-specific template variable references from the general VMware migration assembly, introduces a new CNV-specific PVC name template variable reference module, and updates CNV and VMware CLI migration procedures to document pvcNameTemplate customization at plan and per-VM levels.

Changes

Migration documentation and template variable updates

Layer / File(s) Summary
Template variable documentation structure
documentation/modules/ref_pvc-name-template-variables-cnv.adoc, documentation/doc-Migrating_your_virtual_machines/assemblies/assembly_migrating-from-vmware.adoc, documentation/modules/ref_network-name-template-variables-vmware.adoc, documentation/modules/ref_pvc-name-template-variables-vmware.adoc, documentation/modules/ref_volume-name-template-variables-vmware.adoc
New CNV PVC name template reference module documents variables, Go template functions, DNS compliance, defaults, and examples. VMware template variable reference modules remove the assembly_migrating-from-vmware include, leaving only the planning-migration assembly reference. The migrating-from-vmware assembly removes includes for PVC, network, and volume name template variable modules.
CNV planning and wizard procedures with PVC template support
documentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-cnv.adoc, documentation/modules/proc_creating-plan-wizard-cnv.adoc, documentation/modules/proc_migrating-live-cnv-cnv-vms-cli.adoc
Planning assembly includes the new PVC name template variables reference. Plan wizard updates branded language to project-short and clarifies that source/destination providers are required, adds a NOTE explaining pvcNameTemplate customization in the YAML Plan manifest. Live migration example adds plan-level and per-VM pvcNameTemplate fields with parameter documentation for namespace placeholders and template override behavior.
CNV CLI migration procedure with structured manifest and PVC templates
documentation/modules/proc_migrating-vms-cli-cnv.adoc
Updates source provider reference from {virt} to {a-virt}, restructures Plan manifest with nested map containing network/storage sections with explicit names/namespaces, adds targetNamespace and plan-level pvcNameTemplate, and extends per-VM entries with pvcNameTemplate overrides. Parameter documentation is rewritten to match revised manifest fields with descriptions for target namespace and PVC template variables.
VMware CLI migration documentation with explicit template variable links
documentation/modules/proc_migrating-vms-cli-vmware.adoc
Updates parameter descriptions and per-VM override documentation to use explicit link:{mtv-plan}... URLs pointing to VMware-specific template variable references instead of context-based xref targets, aligning networkNameTemplate, pvcNameTemplate, and volumeNameTemplate documentation with their corresponding variable sets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • kubev2v/forklift-documentation#910: Both PRs are tied to the VMware template-variable documentation cleanup: the main PR removes the PVC/network/volume template variable includes from assembly_migrating-from-vmware.adoc, and the retrieved PR correspondingly updates the ref_* modules to remove lingering references to the same "migrating-from-vmware" assembly.

Suggested reviewers

  • anarnold97
  • jamsmithredhat
  • mnecas

Poem

🐰 Hops through the docs with glee,
PVC names now set wild and free,
Templates bloom where migrations flow,
Each VM knows which name to bestow! 🌻

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'PVC name template CNV' is partially related to the changeset but lacks clarity and specificity. It identifies a key component (PVC name template) and mentions CNV, but does not clearly convey the main change—which involves adding PVC name template support and documentation reorganization. Consider a more descriptive title such as 'Add PVC name template support for CNV migrations' or 'Document PVC name template variables for CNV' to better communicate the primary objective of the changeset.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.

✏️ 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: 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/proc_migrating-vms-cli-cnv.adoc`:
- Line 10: Fix the introductory sentence by changing the article before the
placeholder {a-virt}: replace "migrate from {a-virt} source provider" with
"migrate from an {a-virt} source provider" so the sentence reads correctly with
placeholders {virt} and {a-virt}.
🪄 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: 2edd5bc9-31d2-4f5e-b14c-52831d59c016

📥 Commits

Reviewing files that changed from the base of the PR and between e99ad80 and 8990186.

📒 Files selected for processing (10)
  • documentation/doc-Migrating_your_virtual_machines/assemblies/assembly_migrating-from-vmware.adoc
  • documentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-cnv.adoc
  • documentation/modules/proc_creating-plan-wizard-cnv.adoc
  • documentation/modules/proc_migrating-live-cnv-cnv-vms-cli.adoc
  • documentation/modules/proc_migrating-vms-cli-cnv.adoc
  • documentation/modules/proc_migrating-vms-cli-vmware.adoc
  • documentation/modules/ref_network-name-template-variables-vmware.adoc
  • documentation/modules/ref_pvc-name-template-variables-cnv.adoc
  • documentation/modules/ref_pvc-name-template-variables-vmware.adoc
  • documentation/modules/ref_volume-name-template-variables-vmware.adoc
💤 Files with no reviewable changes (4)
  • documentation/modules/ref_network-name-template-variables-vmware.adoc
  • documentation/modules/ref_volume-name-template-variables-vmware.adoc
  • documentation/doc-Migrating_your_virtual_machines/assemblies/assembly_migrating-from-vmware.adoc
  • documentation/modules/ref_pvc-name-template-variables-vmware.adoc

Comment thread documentation/modules/proc_migrating-vms-cli-cnv.adoc

@yaacov yaacov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

@Jenny-Anne

Copy link
Copy Markdown
Collaborator Author

lgtm

@yaacov Am I okay to merge this PR or do we need to wait for the 2.12 release?

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