✨ add VM naming strategy for VMs in govmomi mode #3286

viveksyngh · 2024-12-08T16:20:05Z

Add VM naming stragey for vsphere vms and VMs in govami mode

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

k8s-ci-robot · 2024-12-08T16:20:14Z

Welcome @viveksyngh!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-vsphere 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-vsphere has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-12-08T16:20:14Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign vincepri for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2024-12-08T16:20:15Z

Hi @viveksyngh. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

- Add VM naming stragey for vsphere vms and VMs in govami mode

- Rename the type to VSphereVMNamingStrategy and update docs, function name etc

neolit123

please give a ping once this is no longer a draft and is ready for review.

/cc

neolit123 · 2024-12-11T07:27:39Z

make sure you add a test.

neolit123 · 2024-12-16T08:24:32Z

apis/v1beta1/vspheremachine_types.go

@@ -68,6 +68,30 @@ type VSphereMachineSpec struct {
 	//
 	// +optional
 	GuestSoftPowerOffTimeout *metav1.Duration `json:"guestSoftPowerOffTimeout,omitempty"`
+
+	// NamingStrategy allows configuring the naming strategy used when calculating the name of the VSphereVM.


calculating -> preparing
as it's not a math calculation.

EDIT: seems consistent with the supervisor PR. so you can leave it as is.

name of the VSphereVM.

this field is inside VSphereMachineSpec not VSphereVMSpec

neolit123 · 2024-12-16T08:24:58Z

apis/v1beta1/vspheremachine_types.go

+// VSphereVMNamingStrategy defines the naming strategy for the VSphereVMs.
+type VSphereVMNamingStrategy struct {


should this be named
VSphereMachineNamingStrategy

neolit123 · 2024-12-16T08:25:19Z

apis/v1beta1/vspheremachine_types.go

+	// * Names are automatically truncated at 63 characters. Please note that this can lead to name conflicts,
+	//   so we highly recommend to use a template which leads to a name shorter than 63 characters.
+	// +optional
+	Template *string `json:"template,omitempty"`


no need for *string, just string?

EDIT: seems consistent with the supervisor PR. so you can leave it as is.

neolit123 · 2024-12-16T08:27:50Z

apis/v1beta1/vspheremachine_types.go

+	// * While the template offers some flexibility, we would like the name to link to the Machine name
+	//   to ensure better user experience when troubleshooting


Suggested change

// * While the template offers some flexibility, we would like the name to link to the Machine name

// to ensure better user experience when troubleshooting

// * While the template offers some flexibility, it is best for the name to link to the Machine name

// to ensure better user experience when troubleshooting

personalization should not be present in official docs (ideally).

EDIT: seems consistent with the supervisor PR. so you can leave it as is.

neolit123 · 2024-12-16T08:29:04Z

internal/webhooks/vspheremachinetemplate.go

 	return nil, AggregateObjErrors(newTyped.GroupVersionKind().GroupKind(), newTyped.Name, allErrs)
 }

 // ValidateDelete implements webhook.Validator so a webhook will be registered for the type.
 func (webhook *VSphereMachineTemplateWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }
+
+func validateVSphereVMNamingTemplate(_ context.Context, vsphereMachineTemplate *infrav1.VSphereMachineTemplate) field.ErrorList {


is this following some code that core CAPI already has or is this done from scratch as a use case for CAPV?
if the former, could you link to that code for reviewer's reference?

This is based on this MR which was added to support this in supervisor mode #3099

In supervisor mode, the object is called VirtualMachine which drives the creation of vSphere VMs while in govami mode this object is called VSphereVM.

looks like a lot comes from that PR.
why not also name it VirtualMachineNamingStrategy here? that seems more consistent despite the diff backend objects.

I can do that if we prefer that. I just to wanted to call it what it is being used for.

that would be my preference. not sure what other reviewers will comment on this.

neolit123 · 2024-12-16T08:30:38Z

pkg/services/vimmachine.go

+	maxNameLength = 63
+)
+
+// Note: Inlining these functions from sprig to avoid introducing a dependency.


sprig is a typo?

neolit123 · 2024-12-16T08:32:03Z

test/e2e/data/infrastructure-vsphere-govmomi/main/clusterclass/patch-vm-namingstrategy.yaml

+- op: add
+  path: /spec/template/spec/namingStrategy
+  value:
+    template: '{{ if le (len .machine.name) 20 }}{{ .machine.name }}{{else}}{{ trimSuffix "-" (trunc 14 .machine.name) }}-{{ trunc -5 .machine.name }}{{end}}'


add missing new line at the end.

viveksyngh · 2024-12-16T09:10:56Z

This MR is more or less similar code from this MR which added the functionality in the supervisor mode. #3099

I can make the requested changes but I have tried to align this as much as possible with supervisor mode changes.

neolit123 · 2024-12-16T12:35:14Z

/ok-to-test

neolit123 · 2024-12-16T12:35:37Z

This MR is more or less similar code from this MR which added the functionality in the supervisor mode. #3099

I can make the requested changes but I have tried to align this as much as possible with supervisor mode changes.

#3286 (comment)

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 8, 2024

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 8, 2024

k8s-ci-robot requested review from MaxRink and srm09 December 8, 2024 16:20

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 8, 2024

viveksyngh force-pushed the vm-naming-strategy branch from c0c07cd to 7ca274d Compare December 8, 2024 16:25

viveksyngh changed the title ~~feat: add VM naming strategy for VMs in govami mode~~ ✨ add VM naming strategy for VMs in govami mode Dec 8, 2024

✨ add VM naming strategy for VMs in govami mode

0deb41a

- Add VM naming stragey for vsphere vms and VMs in govami mode

viveksyngh force-pushed the vm-naming-strategy branch from 7ca274d to 0deb41a Compare December 8, 2024 16:59

chrischdi changed the title ~~✨ add VM naming strategy for VMs in govami mode~~ ✨ add VM naming strategy for VMs in govmomi mode Dec 9, 2024

rename the type to VSphereVMNamingStrategy

782c264

- Rename the type to VSphereVMNamingStrategy and update docs, function name etc

viveksyngh force-pushed the vm-naming-strategy branch from 026364a to 782c264 Compare December 11, 2024 05:35

neolit123 reviewed Dec 11, 2024

View reviewed changes

k8s-ci-robot requested a review from neolit123 December 11, 2024 07:26

add support for a random function

bd815fd

viveksyngh force-pushed the vm-naming-strategy branch from 275cf76 to bd815fd Compare December 11, 2024 08:44

viveksyngh added 2 commits December 14, 2024 11:15

remove random function support

dd8faee

add webhook validation and tests

05bb39b

viveksyngh marked this pull request as ready for review December 16, 2024 04:31

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 16, 2024

k8s-ci-robot requested review from chrischdi and zhanggbj December 16, 2024 04:31

neolit123 reviewed Dec 16, 2024

View reviewed changes

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ add VM naming strategy for VMs in govmomi mode #3286

✨ add VM naming strategy for VMs in govmomi mode #3286

viveksyngh commented Dec 8, 2024

k8s-ci-robot commented Dec 8, 2024

k8s-ci-robot commented Dec 8, 2024

k8s-ci-robot commented Dec 8, 2024

neolit123 left a comment

neolit123 commented Dec 11, 2024

neolit123 Dec 16, 2024 •

edited

Loading

neolit123 Dec 16, 2024

neolit123 Dec 16, 2024

neolit123 Dec 16, 2024

neolit123 Dec 16, 2024 •

edited

Loading

neolit123 Dec 16, 2024

viveksyngh Dec 16, 2024

neolit123 Dec 16, 2024

viveksyngh Dec 16, 2024

neolit123 Dec 16, 2024

neolit123 Dec 16, 2024

neolit123 Dec 16, 2024

viveksyngh commented Dec 16, 2024

neolit123 commented Dec 16, 2024

neolit123 commented Dec 16, 2024

		// VSphereVMNamingStrategy defines the naming strategy for the VSphereVMs.
		type VSphereVMNamingStrategy struct {

		// * While the template offers some flexibility, we would like the name to link to the Machine name
		// to ensure better user experience when troubleshooting

✨ add VM naming strategy for VMs in govmomi mode #3286

Are you sure you want to change the base?

✨ add VM naming strategy for VMs in govmomi mode #3286

Conversation

viveksyngh commented Dec 8, 2024

k8s-ci-robot commented Dec 8, 2024

k8s-ci-robot commented Dec 8, 2024

k8s-ci-robot commented Dec 8, 2024

neolit123 left a comment

Choose a reason for hiding this comment

neolit123 commented Dec 11, 2024

neolit123 Dec 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 Dec 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

viveksyngh commented Dec 16, 2024

neolit123 commented Dec 16, 2024

neolit123 commented Dec 16, 2024

neolit123 Dec 16, 2024 •

edited

Loading

neolit123 Dec 16, 2024 •

edited

Loading