doc: add new section for EFI/vTPM cloning, fix the out of date page in 1.8#1061
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the VM cloning documentation to reflect current UI behavior and documents EFI/vTPM persistent-state cloning behavior for the dev (v1.9) docs, while refreshing the v1.8 versioned page to remove outdated steps/screenshots.
Changes:
- Refresh cloning steps to include run strategy selection and updated screenshots/wording.
- Update v1.8 versioned clone doc screenshots from older
/img/v1.2/...assets to/img/v1.8/.... - Add a new “EFI and vTPM Persistent State” section to the current (v1.9 Dev) clone documentation.
Reviewed changes
Copilot reviewed 2 out of 5 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
versioned_docs/version-v1.8/vm/clone-vm.md |
Updates v1.8 clone steps and screenshots to match current v1.8 UI. |
docs/vm/clone-vm.md |
Updates current (v1.9 Dev) clone steps and adds EFI/vTPM persistent-state cloning guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| :::note | ||
|
|
||
| EFI and vTPM persistent state is stored separately from the volumes listed in `vm.Spec.Template.Spec.Volumes`. Harvester creates this storage only after the source VM has been started at least once. If the source VM has never been started, cloning a VM with EFI or vTPM persistent state can fail because the required source storage does not exist. |
|
jillian-maroket
requested changes
Jul 1, 2026
jillian-maroket
left a comment
jillian-maroket
left a comment
Contributor
There was a problem hiding this comment.
Review done. Please also apply the suggested changes to the v1.8 doc.
|
|
||
| VM can be cloned with/without data. This function doesn't need to take a VM snapshot or set up a backup target first. | ||
|
|
||
| The cloned VM inherits the source VM's basic configuration. Before cloning, you can update settings such as the VM name, volume data cloning, and [run strategy](./create-vm.md#run-strategy). |
Contributor
There was a problem hiding this comment.
Suggested change
| The cloned VM inherits the source VM's basic configuration. Before cloning, you can update settings such as the VM name, volume data cloning, and [run strategy](./create-vm.md#run-strategy). | |
| The cloned virtual machine inherits the source's basic configuration. You can choose whether to include the source's volume data, as well as customize the clone's name and [run strategy](./create-vm.md#run-strategy). |
|
|
||
| The cloned VM inherits the source VM's basic configuration. Before cloning, you can update settings such as the VM name, volume data cloning, and [run strategy](./create-vm.md#run-strategy). | ||
|
|
||
| ## Clone VM with volume data |
Contributor
There was a problem hiding this comment.
Suggested change
| ## Clone VM with volume data | |
| ## Clone a Virtual Machine with Volume Data |
|
|
||
| ## Clone VM with volume data | ||
|
|
||
| 1. On the `Virtual Machines` page, click `Clone` of the VM actions. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. On the `Virtual Machines` page, click `Clone` of the VM actions. | |
| 1. On the **Virtual Machines** screen, locate the target virtual machine and select **⋮ > Clone**. | |
|  |
Contributor
There was a problem hiding this comment.
The image is more relevant to this step.
| 1. On the `Virtual Machines` page, click `Clone` of the VM actions. | ||
| 1. Set a new VM name and click `Create` to create a new VM. | ||
|  | ||
| 2. Select a [run strategy](./create-vm.md#run-strategy). The cloned VM uses the source VM's run strategy by default. |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. Select a [run strategy](./create-vm.md#run-strategy). The cloned VM uses the source VM's run strategy by default. | |
| 1. Specify a unique name for the cloned virtual machine. | |
| 1. Select a [run strategy](./create-vm.md#run-strategy). | |
| The cloned virtual machine uses the source's run strategy by default. |
Contributor
There was a problem hiding this comment.
The suggested steps reflect how New Virtual Machine Name appears before Run Strategy.
Comment on lines
+28
to
+29
| 3. Set a new VM name and click `Create` to create a new VM. | ||
|  |
Contributor
There was a problem hiding this comment.
Suggested change
| 3. Set a new VM name and click `Create` to create a new VM. | |
|  | |
| 1. Click **Create**. |
Comment on lines
+48
to
+50
| - If both EFI and vTPM are enabled, Harvester preserves both persistent states. | ||
| - If only EFI or only vTPM is enabled, Harvester preserves only the selected persistent state. | ||
| - If neither EFI nor vTPM is enabled, Harvester does not process the persistent state storage. |
Contributor
There was a problem hiding this comment.
Suggested change
| - If both EFI and vTPM are enabled, Harvester preserves both persistent states. | |
| - If only EFI or only vTPM is enabled, Harvester preserves only the selected persistent state. | |
| - If neither EFI nor vTPM is enabled, Harvester does not process the persistent state storage. | |
| | EFI Status | vTPM Status | Harvester Behavior | | |
| | --- | --- | --- | | |
| | Enabled | Enabled | Preserves both persistent states | | |
| | Enabled | Disabled | Preserves only the EFI state | | |
| | Disabled | Enabled | Preserves only the vTPM state | | |
| | Diasbled | Disabled | Skips processing of persistent state storage | |
| - If only EFI or only vTPM is enabled, Harvester preserves only the selected persistent state. | ||
| - If neither EFI nor vTPM is enabled, Harvester does not process the persistent state storage. | ||
|
|
||
| The cloned VM may stay in the `Pending` state while Harvester copies and prepares the persistent state storage. |
Contributor
There was a problem hiding this comment.
Suggested change
| The cloned VM may stay in the `Pending` state while Harvester copies and prepares the persistent state storage. | |
| The cloned virtual machine may remain in the `Pending` state while Harvester prepares the persistent state storage. |
|
|
||
|  | ||
|
|
||
| :::note |
Contributor
There was a problem hiding this comment.
Suggested change
| :::note | |
| :::caution |
|
|
||
| :::note | ||
|
|
||
| EFI and vTPM persistent state is stored separately from the volumes listed in `vm.Spec.Template.Spec.Volumes`. Harvester creates this storage only after the source VM has been started at least once. If the source VM has never been started, cloning a VM with EFI or vTPM persistent state can fail because the required source storage does not exist. |
Comment on lines
+60
to
+64
| ::: | ||
|
|
||
| :::caution | ||
|
|
||
| Because the persistent state is copied from the source VM, guest-visible firmware identifiers such as the firmware UUID will be the same on the cloned VM. The cloned VM still has its own VM object identity in Harvester. |
Contributor
There was a problem hiding this comment.
Suggested change
| ::: | |
| :::caution | |
| Because the persistent state is copied from the source VM, guest-visible firmware identifiers such as the firmware UUID will be the same on the cloned VM. The cloned VM still has its own VM object identity in Harvester. | |
| Because the persistent state is copied directly from the source, the cloned virtual machine will inherit identical guest-visible firmware identifiers (including the firmware UUID). However, the clone retains its own virtual machine object identity within Harvester. |
Contributor
There was a problem hiding this comment.
I suggest that we combine the two notes.
…n 1.8 Signed-off-by: pohanhuang <pohan.huang@suse.com> fix: add efi tpm screen shot
Signed-off-by: pohanhuang <pohan.huang@suse.com>
Contributor
Author
|
@jillian-maroket thanks for the review. |
jillian-maroket
approved these changes
Jul 1, 2026
|
Tick the box to add this pull request to the merge queue (same as
|
jillian-maroket
added
the
product-doc/added
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
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.
Problem:
Solution:
Related Issue(s):
harvester/harvester#9182
Test plan:
Additional documentation or context
v1.8
v1.9