Skip to content

CNV-93555: Add VM template categories documentation - #119832

Open
abrennan89 wants to merge 3 commits into
openshift:mainfrom
abrennan89:CNV-93555
Open

abrennan89 wants to merge 3 commits into
openshift:mainfrom
abrennan89:CNV-93555

Conversation

@abrennan89

@abrennan89 abrennan89 commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Added documentation for the new VM template categories feature (CNV-93555, epic CNV-92485), which lets users organize and filter VM templates by application type using the vm.kubevirt.io/category label.
  • Created 5 new modules: concept (about categories), 3 procedures (edit category, filter by category, set category on save-as-template), and a reference (category column behavior).
  • Updated the existing Create VM from Template procedure to mention the dedicated Category filter.
  • Added a new "VM template categories" section to the templates assembly.

Test plan

  • Verify the assembly builds and renders correctly with the new modules
  • Verify the concept module accurately describes categories vs. workload profiles
  • Verify all 3 procedure modules match the current UI behavior (demo: CNV-93554: Filter and edit VMT categories in list, details, and catalog kubevirt-ui/kubevirt-plugin#4398)
  • Verify the reference table correctly describes Category column behavior for VirtualMachineTemplates vs. OpenShift templates
  • Verify the updated filter step in virt-creating-vm-from-template-web.adoc is accurate

Jira: https://redhat.atlassian.net/browse/CNV-93555
Epic: https://redhat.atlassian.net/browse/CNV-92485

🤖 Generated with Claude Code

Add documentation for the new VM template categories feature, which
allows users to organize and filter templates by application type using
the vm.kubevirt.io/category label.

New modules:
- About VM template categories (concept)
- Editing a VM template category (procedure)
- Filtering VM templates by category (procedure)
- Setting a category when saving a VM as a template (procedure)
- VM template category column reference (reference)

Updated modules:
- virt-creating-vm-from-template-web: updated filter step to mention
  the dedicated Category filter
- virt-creating-vms-from-templates assembly: added new VM template
  categories section with all new modules

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Sep 15, 2026
@openshift-ci-robot

openshift-ci-robot commented Sep 15, 2026

Copy link
Copy Markdown

@abrennan89: This pull request references CNV-93555 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.1.0" version, but no target version was set.

Details

In response to this:

Summary

  • Added documentation for the new VM template categories feature (CNV-93555, epic CNV-92485), which lets users organize and filter VM templates by application type using the vm.kubevirt.io/category label.
  • Created 5 new modules: concept (about categories), 3 procedures (edit category, filter by category, set category on save-as-template), and a reference (category column behavior).
  • Updated the existing Create VM from Template procedure to mention the dedicated Category filter.
  • Added a new "VM template categories" section to the templates assembly.

Test plan

  • Verify the assembly builds and renders correctly with the new modules
  • Verify the concept module accurately describes categories vs. workload profiles
  • Verify all 3 procedure modules match the current UI behavior (demo: CNV-93554: Filter and edit VMT categories in list, details, and catalog kubevirt-ui/kubevirt-plugin#4398)
  • Verify the reference table correctly describes Category column behavior for VirtualMachineTemplates vs. OpenShift templates
  • Verify the updated filter step in virt-creating-vm-from-template-web.adoc is accurate

Jira: https://redhat.atlassian.net/browse/CNV-93555
Epic: https://redhat.atlassian.net/browse/CNV-92485

🤖 Generated with Claude Code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 15, 2026
abrennan89 and others added 2 commits September 15, 2026 10:24
- Use imperative form for procedure titles (Edit, Filter, Set)
- Replace "appears" with "is displayed" per Red Hat style guide
- Use active voice for category storage descriptions
- Replace "Alternatively" with simpler phrasing
- Backtick VirtualMachineTemplate API object references

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Per engineering feedback, document category support differences across
all three template types:
- v1beta1 VirtualMachineTemplate: full support (create + edit)
- v1alpha1 VirtualMachineTemplate: edit-only (VMTR CRD limitation)
- OpenShift Template: no category support (uses workload profile)

Updated concept module with "Category support by template type" section,
added a note to the save-as-template procedure about the v1beta1
requirement, expanded the reference table to show all three types, and
clarified the editing procedure applies to both versions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@abrennan89

Copy link
Copy Markdown
Contributor Author

/retest

@openshift-ci

openshift-ci Bot commented Sep 15, 2026

Copy link
Copy Markdown

@abrennan89: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/validate-asciidoc 4060364 link true /test validate-asciidoc

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants