✨ Add vm.spec.cdrom API and initial reconcile logic #594

dilyar85 · 2024-06-24T23:24:50Z

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

This PR introduces a new vm.spec.cdrom field and the initial reconciliation logic based on the VM power state change:

If VM is about to power on, it adds/removes/updates/ CD-ROM devices with the expected backing (from ISO-type Virtual Machine Image) and connection state.
If VM is already powered on, it only updates the existing CD-ROM device connection state if changed.

Which issue(s) is/are addressed by this PR?

Fixes N/A.

Are there any special notes for your reviewer:

This PR only focuses on the API and reconciliation logic regarding CD-ROM device changes.
Follow-up PRs will be submitted to address necessary VM webhook and documentation updates.

Please add a release note if necessary:

Add vm.spec.cdrom API and initial reconcile logic to support VM deployment from ISO.

Testing Done

Added cdrom_test.go file to test the new cdrom.go file with 100% coverage:

$ go test -coverprofile=/tmp/coverage.out -run ^TestVSphereVirtualMachine$ github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm
ok  	github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm	77.980s	coverage: 86.0% of statements

$ go tool cover -func=/tmp/coverage.out | grep pkg/util/vsphere/vm/cdrom.go
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm/cdrom.go:31:		UpdateCdromDeviceChanges		100.0%
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm/cdrom.go:105:		UpdateConfigSpecCdromDeviceConnection	100.0%
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm/cdrom.go:147:		getCdromAndBackingByImgRef		100.0%
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm/cdrom.go:176:		createNewCdrom				100.0%
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm/cdrom.go:202:		ensureAllCdromsHaveControllers		100.0%
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm/cdrom.go:232:		addNewAHCIController			100.0%
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm/cdrom.go:285:		getIsoFilenameFromImageRef		100.0%
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm/cdrom.go:349:		updateCurCdromsConnectionState		100.0%

Updated the existing session_vm_update_test.go when ISO FSS is enabled
Deployed the change to an internal testbed and verified adding/removing/updating CD-ROM devices against a VM Service VM

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

akutz

Great work @dilyar85! Please see the requested changes.

api/v1alpha3/virtualmachine_types.go

pkg/util/vsphere/vm/cdrom.go

dougm

lgtm!

dilyar85 · 2024-07-02T22:16:11Z

Submitted #611 to address the ci/vulncheck-go check failure.

config/crd/external-crds/imageregistry.vmware.com_clustercontentlibraryitems.yaml

api/v1alpha3/virtualmachine_types.go

config/crd/external-crds/imageregistry.vmware.com_contentlibraries.yaml

config/crd/external-crds/imageregistry.vmware.com_contentlibraryitems.yaml

api/v1alpha3/virtualmachine_types.go

pkg/util/vsphere/vm/cdrom.go

akutz

Thank you @dilyar85, this is really good, but I did have a few thoughts.

aruneshpa

LGTM. Thanks for the update.

api/v1alpha3/virtualmachine_types.go

This patch introduces a new `vm.spec.cdrom` field and the reconciliation logic based on the VM power state change: - If VM is about to power on, it adds/removes/updates/ CD-ROM devices with the expected backing (from ISO-type Virtual Machine Image) and connection state. - If VM is already powered on, it only updates the existing CD-ROM device connection state if changed.

dilyar85 · 2024-07-09T23:07:53Z

To wrap up the above conversations about the "connection state" in the CD-ROM spec, the team has concluded to name that API field connected with a default true value. The PR has been updated to reflect this change.

github-actions · 2024-07-09T23:26:08Z

Package	Line Rate	Health
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/clustercontentlibraryitem	81%	➖
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/contentlibraryitem	85%	➖
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/utils	97%	✔
github.com/vmware-tanzu/vm-operator/controllers/infra/capability	86%	➖
github.com/vmware-tanzu/vm-operator/controllers/infra/configmap	73%	❌
github.com/vmware-tanzu/vm-operator/controllers/infra/node	77%	❌
github.com/vmware-tanzu/vm-operator/controllers/infra/secret	77%	❌
github.com/vmware-tanzu/vm-operator/controllers/util/encoding	73%	❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine	87%	➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineclass	75%	❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinepublishrequest	81%	➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinereplicaset	67%	❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineservice	83%	➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineservice/providers	92%	✔
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinesetresourcepolicy	80%	➖
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/virtualmachinewebconsolerequest/v1alpha2	73%	❌
github.com/vmware-tanzu/vm-operator/controllers/volume	85%	➖
github.com/vmware-tanzu/vm-operator/pkg/builder	95%	✔
github.com/vmware-tanzu/vm-operator/pkg/conditions	88%	➖
github.com/vmware-tanzu/vm-operator/pkg/config	100%	✔
github.com/vmware-tanzu/vm-operator/pkg/config/env	100%	✔
github.com/vmware-tanzu/vm-operator/pkg/patch	78%	❌
github.com/vmware-tanzu/vm-operator/pkg/prober	91%	✔
github.com/vmware-tanzu/vm-operator/pkg/prober/probe	91%	✔
github.com/vmware-tanzu/vm-operator/pkg/prober/worker	77%	❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere	75%	❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/client	80%	➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/clustermodules	71%	❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/config	72%	❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/contentlibrary	72%	❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/credentials	100%	✔
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/network	80%	➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/placement	77%	❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/session	74%	❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/sysprep	100%	✔
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/vcenter	82%	➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/virtualmachine	74%	❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/vmlifecycle	67%	❌
github.com/vmware-tanzu/vm-operator/pkg/record	78%	❌
github.com/vmware-tanzu/vm-operator/pkg/topology	92%	✔
github.com/vmware-tanzu/vm-operator/pkg/util	87%	➖
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	81%	➖
github.com/vmware-tanzu/vm-operator/pkg/util/ptr	100%	✔
github.com/vmware-tanzu/vm-operator/pkg/util/resize	99%	✔
github.com/vmware-tanzu/vm-operator/pkg/util/vmopv1	90%	✔
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/client	68%	❌
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm	86%	➖
github.com/vmware-tanzu/vm-operator/pkg/webconsolevalidation	100%	✔
github.com/vmware-tanzu/vm-operator/webhooks/common	100%	✔
github.com/vmware-tanzu/vm-operator/webhooks/persistentvolumeclaim/validation	95%	✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachine/mutation	85%	➖
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/virtualmachinepublishrequest/validation	92%	✔
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/virtualmachinewebconsolerequest/v1alpha1/validation	92%	✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinewebconsolerequest/v1alpha2/validation	92%	✔
Summary	81% (8369 / 10283)	➖

Minimum allowed line rate is 79%

akutz

Thank you @dilyar85 !!

vmwclabot added the cla-not-required label Jun 24, 2024

github-actions bot added the size/L Denotes a PR that changes 100-499 lines. label Jun 24, 2024

dilyar85 force-pushed the feature/add-cd-rom branch 3 times, most recently from 6c46cb5 to bf02bdf Compare June 24, 2024 23:41

dilyar85 marked this pull request as draft June 25, 2024 02:14

akutz requested changes Jun 25, 2024

View reviewed changes

dougm reviewed Jun 25, 2024

View reviewed changes

pkg/util/vsphere/vm/cdrom.go Outdated Show resolved Hide resolved

dilyar85 force-pushed the feature/add-cd-rom branch from bf02bdf to 42b5490 Compare June 27, 2024 20:13

github-actions bot added size/XL Denotes a PR that changes 500-999 lines. and removed size/L Denotes a PR that changes 100-499 lines. labels Jun 27, 2024

dilyar85 force-pushed the feature/add-cd-rom branch from 42b5490 to ddb02da Compare June 27, 2024 20:15

bryanv reviewed Jun 28, 2024

View reviewed changes

pkg/util/vsphere/vm/cdrom.go Show resolved Hide resolved

dilyar85 force-pushed the feature/add-cd-rom branch from ddb02da to d8d7258 Compare July 2, 2024 18:00

github-actions bot added size/XXL Denotes a PR that changes 1000+ lines. and removed size/XL Denotes a PR that changes 500-999 lines. labels Jul 2, 2024

dilyar85 marked this pull request as ready for review July 2, 2024 18:00

dilyar85 force-pushed the feature/add-cd-rom branch 3 times, most recently from d6bf977 to 924ee88 Compare July 2, 2024 18:28

dougm approved these changes Jul 2, 2024

View reviewed changes

dilyar85 force-pushed the feature/add-cd-rom branch from 924ee88 to 488888e Compare July 2, 2024 21:01

dilyar85 force-pushed the feature/add-cd-rom branch 2 times, most recently from c42de1c to 3b0e2d7 Compare July 3, 2024 14:20

zyiyi11 reviewed Jul 3, 2024

View reviewed changes

dilyar85 force-pushed the feature/add-cd-rom branch 4 times, most recently from fbc095c to 8547995 Compare July 8, 2024 15:12

dilyar85 requested a review from akutz July 8, 2024 15:35

akutz requested changes Jul 9, 2024

View reviewed changes

aruneshpa approved these changes Jul 9, 2024

View reviewed changes

api/v1alpha3/virtualmachine_types.go Outdated Show resolved Hide resolved

dilyar85 force-pushed the feature/add-cd-rom branch 2 times, most recently from c53d88f to c9a1acb Compare July 9, 2024 21:42

dilyar85 requested a review from akutz July 9, 2024 21:50

dilyar85 force-pushed the feature/add-cd-rom branch from c9a1acb to d31be15 Compare July 9, 2024 23:03

akutz approved these changes Jul 10, 2024

View reviewed changes

dilyar85 merged commit 290e215 into vmware-tanzu:main Jul 10, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Add vm.spec.cdrom API and initial reconcile logic #594

✨ Add vm.spec.cdrom API and initial reconcile logic #594

dilyar85 commented Jun 24, 2024 •

edited by github-actions bot

Loading

akutz left a comment

dougm left a comment

dilyar85 commented Jul 2, 2024

akutz left a comment

aruneshpa left a comment

dilyar85 commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

akutz left a comment

✨ Add vm.spec.cdrom API and initial reconcile logic #594

✨ Add vm.spec.cdrom API and initial reconcile logic #594

Conversation

dilyar85 commented Jun 24, 2024 • edited by github-actions bot Loading

akutz left a comment

Choose a reason for hiding this comment

dougm left a comment

Choose a reason for hiding this comment

dilyar85 commented Jul 2, 2024

akutz left a comment

Choose a reason for hiding this comment

aruneshpa left a comment

Choose a reason for hiding this comment

dilyar85 commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

akutz left a comment

Choose a reason for hiding this comment

dilyar85 commented Jun 24, 2024 •

edited by github-actions bot

Loading