Skip to content

CNV-85776: Document native VirtualMachineTemplates (TP) - #119463

Open
rheslop wants to merge 1 commit into
openshift:mainfrom
rheslop:main-cnv-85776
Open

rheslop wants to merge 1 commit into
openshift:mainfrom
rheslop:main-cnv-85776

Conversation

@rheslop

@rheslop rheslop commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Add Tech Preview documentation for the native VirtualMachineTemplate feature, covering enabling the feature gate, creating templates from existing VMs, cross-namespace template creation, creating VMs from templates, and a parameter reference.

  • Minor edits
  • Updates based on feedback, and auto-peer check`

CNV#85776

Version(s):
5.0

Issue:
https://redhat.atlassian.net/browse/CNV-85776

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@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 4, 2026
@openshift-ci-robot

openshift-ci-robot commented Sep 4, 2026

Copy link
Copy Markdown

@rheslop: This pull request references CNV-85776 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:

Add Tech Preview documentation for the native VirtualMachineTemplate feature, covering enabling the feature gate, creating templates from existing VMs, cross-namespace template creation, creating VMs from templates, and a parameter reference.

  • Minor edits
  • Updates based on feedback, and auto-peer check`

CNV#85776

Version(s):
5.0

Issue:
https://redhat.atlassian.net/browse/CNV-85776

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 4, 2026

@0xFelix 0xFelix 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.

There is also virtctl template convert, which tries to convert an existing OpenShift Template to a native VirtualMachineTemplate. It could be worth mentioning that.

Comment thread modules/virt-convert-vm-to-reusable-template.adoc Outdated

.Procedure

. Create a `VirtualMachineTemplateRequest` manifest:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

There's also a virtctl command for this. (virtctl template create)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Would it be better to revise so that virtctl commands are used in place pf the current procedure?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I'd show both. Under the hood, virtctl does the same. But it might be more convenient to use virtctl.


* You have installed the `virtctl` CLI.
* A `VirtualMachineTemplate` exists in the cluster.
* You have the `process/create` subresource permission on the `VirtualMachineTemplate` resource.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

There's also a --local flag that can be used with virtctl template process to process a template locally. (not requiring permission on the process subresource).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I added a note with this below if you want to take a look. Thanks!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've added a note that the virtctl command can also be used. Do you think we'll need more?


.Procedure

. Create a `VirtualMachineTemplateRequest` manifest that specifies the target namespace:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

As mentioned above, there's also a virtctl command for this.

@ocpdocs-previewbot

ocpdocs-previewbot commented Sep 10, 2026

Copy link
Copy Markdown

🤖 Tue Sep 15 22:55:17 - Prow CI generated the docs preview:

https://119463--ocpdocs-pr.netlify.app/

Add Tech Preview documentation for the native VirtualMachineTemplate
feature, covering enabling the feature gate, creating templates from
existing VMs, cross-namespace template creation, creating VMs from
templates, and a parameter reference.
* Minor edits
* Updates based on feedback, and auto-peer check`

* Update modules/virt-convert-vm-to-reusable-template.adoc
* Add more text with virtclt command, combined two modules
* Adding virtclt commands
@openshift-ci

openshift-ci Bot commented Sep 15, 2026

Copy link
Copy Markdown

@rheslop: all tests passed!

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.

4 participants