Skip to content

📖 Document VirtualMachineSnapshot concept #1273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
palnabarun wants to merge 2 commits into
base: main
Choose a base branch
from
Open

📖 Document VirtualMachineSnapshot concept #1273

palnabarun wants to merge 2 commits into from
+236 −1

Conversation

@palnabarun
Copy link
Contributor

@palnabarun palnabarun commented Oct 27, 2025 •
edited by github-actions bot
Loading

What does this PR do, and why is it needed?

Adds documentation for the VirtualMachineSnapshot
concept including usage, examples, and
troubleshooting tips.

Which issue(s) is/are addressed by this PR? (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

NA

Are there any special notes for your reviewer:

None

Please add a release note if necessary:

Document VirtualMachineSnapshot API and the VirtualMachine spec.currentSnapshotName, status.rootSnapshots and status.currentSnapshot fields

📚 Documentation preview 📚: https://vm-operator--1273.org.readthedocs.build/en/1273/

@palnabarun palnabarun requested a review from lubronzhan October 27, 2025 16:02
@github-actions github-actions bot added the size/L Denotes a PR that changes 100-499 lines. label Oct 27, 2025
@palnabarun
📖 Document VirtualMachineSnapshot concept
bfa3fb8 
Adds documentation for the VirtualMachineSnapshot
concept including usage, examples, and
troubleshooting tips.

Signed-off-by: Nabarun Pal <nabarun.pal@broadcom.com>
@github-actions
Copy link

github-actions bot commented Oct 27, 2025

Code Coverage

Package Line Rate Health
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/clustercontentlibraryitem 67% ❌
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/contentlibraryitem 67% ❌
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/utils 46% ❌
github.com/vmware-tanzu/vm-operator/controllers/infra/capability/configmap 92% ✔
github.com/vmware-tanzu/vm-operator/controllers/infra/capability/crd 100% ✔
github.com/vmware-tanzu/vm-operator/controllers/infra/configmap 75% ❌
github.com/vmware-tanzu/vm-operator/controllers/infra/node 77% ❌
github.com/vmware-tanzu/vm-operator/controllers/infra/secret 76% ❌
github.com/vmware-tanzu/vm-operator/controllers/infra/validatingwebhookconfiguration 87% ➖
github.com/vmware-tanzu/vm-operator/controllers/infra/zone 73% ❌
github.com/vmware-tanzu/vm-operator/controllers/storageclass 95% ✔
github.com/vmware-tanzu/vm-operator/controllers/storagepolicyquota 98% ✔
github.com/vmware-tanzu/vm-operator/controllers/util/encoding 73% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine/storagepolicyusage 96% ✔
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine/virtualmachine 69% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine/volume 87% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine/volumebatch 81% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineclass 73% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinegroup 89% ✔
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinegrouppublishrequest 88% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineimagecache 88% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinepublishrequest 82% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinereplicaset 67% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineservice 82% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineservice/providers 92% ✔
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinesetresourcepolicy 81% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinesnapshot 95% ✔
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinewebconsolerequest 72% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinewebconsolerequest/v1alpha1 72% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinewebconsolerequest/v1alpha1/conditions 88% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinewebconsolerequest/v1alpha1/patch 78% ❌
github.com/vmware-tanzu/vm-operator/controllers/vspherepolicy/policyevaluation 93% ✔
github.com/vmware-tanzu/vm-operator/pkg/bitmask 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/builder 94% ✔
github.com/vmware-tanzu/vm-operator/pkg/conditions 90% ✔
github.com/vmware-tanzu/vm-operator/pkg/config 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/config/capabilities 98% ✔
github.com/vmware-tanzu/vm-operator/pkg/config/env 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/context 25% ❌
github.com/vmware-tanzu/vm-operator/pkg/context/generic 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/context/operation 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/crd 75% ❌
github.com/vmware-tanzu/vm-operator/pkg/errors 75% ❌
github.com/vmware-tanzu/vm-operator/pkg/exit 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/log 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/mem 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/patch 78% ❌
github.com/vmware-tanzu/vm-operator/pkg/prober 89% ➖
github.com/vmware-tanzu/vm-operator/pkg/prober/probe 90% ✔
github.com/vmware-tanzu/vm-operator/pkg/prober/worker 77% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere 74% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/clustermodules 73% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/config 88% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/contentlibrary 75% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/credentials 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/network 81% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/placement 74% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/session 50% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/storage 44% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/upgrade/virtualmachine 96% ✔
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/vcenter 85% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/virtualmachine 86% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/vmlifecycle 71% ❌
github.com/vmware-tanzu/vm-operator/pkg/record 87% ➖
github.com/vmware-tanzu/vm-operator/pkg/topology 91% ✔
github.com/vmware-tanzu/vm-operator/pkg/util 78% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/cloudinit 89% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/cloudinit/validate 91% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/image 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/kube 91% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/kube/cource 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/kube/internal 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/kube/proxyaddr 73% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/kube/spq 99% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/linuxprep 97% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/netplan 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/ovfcache 75% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/ovfcache/internal 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/paused 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/ptr 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/resize 98% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/sysprep 98% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/vmopv1 88% ➖
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/client 66% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/library 96% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm 79% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/watcher 85% ➖
github.com/vmware-tanzu/vm-operator/pkg/vmconfig 95% ✔
github.com/vmware-tanzu/vm-operator/pkg/vmconfig/anno2extraconfig 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/vmconfig/bootoptions 97% ✔
github.com/vmware-tanzu/vm-operator/pkg/vmconfig/crypto 91% ✔
github.com/vmware-tanzu/vm-operator/pkg/vmconfig/diskpromo 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/vmconfig/policy 96% ✔
github.com/vmware-tanzu/vm-operator/pkg/vmconfig/virtualcontroller 85% ➖
github.com/vmware-tanzu/vm-operator/pkg/webconsolevalidation 100% ✔
github.com/vmware-tanzu/vm-operator/services/vm-watcher 94% ✔
github.com/vmware-tanzu/vm-operator/webhooks/common 98% ✔
github.com/vmware-tanzu/vm-operator/webhooks/persistentvolumeclaim/validation 95% ✔
github.com/vmware-tanzu/vm-operator/webhooks/unifiedstoragequota/validation 88% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachine/mutation 84% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachine/validation 95% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachineclass/mutation 62% ❌
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachineclass/validation 89% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinegroup/mutation 87% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinegroup/validation 92% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinegrouppublishrequest/mutation 86% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinegrouppublishrequest/validation 88% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinepublishrequest/validation 93% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinereplicaset/validation 90% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachineservice/mutation 67% ❌
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachineservice/validation 92% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinesetresourcepolicy/validation 89% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinesnapshot/mutation 83% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinesnapshot/validation 89% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinewebconsolerequest/v1alpha1/validation 92% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinewebconsolerequest/validation 92% ✔
Summary 82% (15949 / 19479) ➖

Minimum allowed line rate is 79%

bryanv
bryanv reviewed Dec 3, 2025
View reviewed changes
docs/concepts/workloads/vm-snapshot.md
@@ -0,0 +1,191 @@
# VirtualMachineSnapshot

VirtualMachineSnapshot resources enable consumers to take Snapshot of their VirtualMachines. It leverages the providers Snapshot capabilities to create VM snapshots.
Copy link
Contributor

@bryanv bryanv Dec 3, 2025

Choose a reason for hiding this comment

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

Maybe providers -> vCenter ?

Copy link
Contributor Author

@palnabarun palnabarun Dec 4, 2025

Choose a reason for hiding this comment

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

I was attempting to be agnostic in the language. vCenter works too.

@dilyar85
Copy link
Member

dilyar85 commented Jan 5, 2026

Hey @palnabarun, can you resolve the following typos reported by the CI so that we can merge this PR in?

rror: `queisce` should be `quiesce`
   ╭▸ ./docs/concepts/workloads/vm-snapshot.md:57:3
   │
57 │   queisce:
   ╰╴  ━━━━━━━
error: `succesfully` should be `successfully`
   ╭▸ ./docs/concepts/workloads/vm-snapshot.md:76:176
   │
76 │ …nd `spec.currentSnapshotName` would be removed if the VM was succesfully reverted.
   ╰╴                                                              ━━━━━━━━━━━
error: `succesfully` should be `successfully`
    ╭▸ ./docs/concepts/workloads/vm-snapshot.md:146:57
    │
146 │ | `VirtualMachineSnapshotReady`     | Snapshot has been succesfully reconciled  |
    ╰╴                                                        ━━━━━━━━━━━
error: `succesfully` should be `successfully`
    ╭▸ ./docs/concepts/workloads/vm-snapshot.md:152:57
    │
152 │ | `VirtualMachineSnapshotRevertSucceeded` | Snapshot is succesfully reverted. This condition can be seen only when the snapshot rever…
    ╰╴                                                        ━━━━━━━━━━━
error: `succesful` should be `successful`
     ╭▸ ./docs/concepts/workloads/vm.md:1400:4
     │
1400 │ is succesful. After a succesful revert operation, `spec.currentSnapshotName`
     ╰╴   ━━━━━━━━━
error: `succesful` should be `successful`
     ╭▸ ./docs/concepts/workloads/vm.md:1400:23
     │
1400 │ is succesful. After a succesful revert operation, `spec.currentSnapshotName`
     ╰╴                      ━━━━━━━━━

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

Reviewers

@bryanv bryanv bryanv left review comments

@dilyar85 dilyar85 dilyar85 approved these changes

@lubronzhan lubronzhan Awaiting requested review from lubronzhan

Assignees

No one assigned

Labels

size/L Denotes a PR that changes 100-499 lines.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@palnabarun @dilyar85 @bryanv