✨ add VM naming strategy for VMs in govmomi mode #3286
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1026,6 +1026,28 @@ spec: | |
| virtual machine is cloned. | ||
| format: int64 | ||
| type: integer | ||
| namingStrategy: | ||
| description: NamingStrategy allows configuring the naming strategy | ||
| used when calculating the name of the VSphereVM. | ||
| properties: | ||
| template: | ||
| description: |- | ||
| Template defines the template to use for generating the name of the VSphereVM object. | ||
| If not defined, it will fall back to `{{ .machine.name }}`. | ||
| The templating has the following data available: | ||
| * `.machine.name`: The name of the Machine object. | ||
| The templating also has the following funcs available: | ||
| * `trimSuffix`: same as strings.TrimSuffix | ||
| * `trunc`: truncates a string, e.g. `trunc 2 "hello"` or `trunc -2 "hello"` | ||
| Notes: | ||
| * While the template offers some flexibility, we would like the name to link to the Machine name | ||
| to ensure better user experience when troubleshooting | ||
| * Generated names must be valid Kubernetes names as they are used to create a VSphereVM object | ||
| and usually also as the name of the Node object. | ||
| * 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. | ||
| type: string | ||
| type: object | ||
| network: | ||
| description: Network is the network configuration for this machine's | ||
| VM. | ||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -896,6 +896,28 @@ spec: | |
| virtual machine is cloned. | ||
| format: int64 | ||
| type: integer | ||
| namingStrategy: | ||
| description: NamingStrategy allows configuring the naming | ||
| strategy used when calculating the name of the VSphereVM. | ||
| properties: | ||
| template: | ||
| description: |- | ||
| Template defines the template to use for generating the name of the VSphereVM object. | ||
| If not defined, it will fall back to `{{ .machine.name }}`. | ||
| The templating has the following data available: | ||
| * `.machine.name`: The name of the Machine object. | ||
| The templating also has the following funcs available: | ||
| * `trimSuffix`: same as strings.TrimSuffix | ||
| * `trunc`: truncates a string, e.g. `trunc 2 "hello"` or `trunc -2 "hello"` | ||
| Notes: | ||
| * While the template offers some flexibility, we would like the name to link to the Machine name | ||
| to ensure better user experience when troubleshooting | ||
| * Generated names must be valid Kubernetes names as they are used to create a VSphereVM object | ||
| and usually also as the name of the Node object. | ||
| * 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. | ||
| type: string | ||
| type: object | ||
| network: | ||
| description: Network is the network configuration for this | ||
| machine's VM. | ||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,13 +24,15 @@ import ( | |
|
|
||
| apierrors "k8s.io/apimachinery/pkg/api/errors" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/apimachinery/pkg/util/validation" | ||
| "k8s.io/apimachinery/pkg/util/validation/field" | ||
| "sigs.k8s.io/cluster-api/util/topology" | ||
| ctrl "sigs.k8s.io/controller-runtime" | ||
| "sigs.k8s.io/controller-runtime/pkg/webhook" | ||
| "sigs.k8s.io/controller-runtime/pkg/webhook/admission" | ||
|
|
||
| infrav1 "sigs.k8s.io/cluster-api-provider-vsphere/apis/v1beta1" | ||
| "sigs.k8s.io/cluster-api-provider-vsphere/pkg/services" | ||
| ) | ||
|
|
||
| const machineTemplateImmutableMsg = "VSphereMachineTemplate spec.template.spec field is immutable. Please create a new resource instead." | ||
|
|
@@ -50,7 +52,7 @@ func (webhook *VSphereMachineTemplateWebhook) SetupWebhookWithManager(mgr ctrl.M | |
| } | ||
|
|
||
| // ValidateCreate implements webhook.Validator so a webhook will be registered for the type. | ||
| func (webhook *VSphereMachineTemplateWebhook) ValidateCreate(ctx context.Context, raw runtime.Object) (admission.Warnings, error) { | ||
| obj, ok := raw.(*infrav1.VSphereMachineTemplate) | ||
| if !ok { | ||
| return nil, apierrors.NewBadRequest(fmt.Sprintf("expected a VSphereMachineTemplate but got a %T", raw)) | ||
|
|
@@ -87,6 +89,10 @@ func (webhook *VSphereMachineTemplateWebhook) ValidateCreate(_ context.Context, | |
| pciErrs := validatePCIDevices(spec.PciDevices) | ||
| allErrs = append(allErrs, pciErrs...) | ||
|
|
||
| templateErrs := validateVSphereVMNamingTemplate(ctx, obj) | ||
| if len(templateErrs) > 0 { | ||
| allErrs = append(allErrs, templateErrs...) | ||
| } | ||
| return nil, AggregateObjErrors(obj.GroupVersionKind().GroupKind(), obj.Name, allErrs) | ||
| } | ||
|
|
||
|
|
@@ -111,10 +117,45 @@ func (webhook *VSphereMachineTemplateWebhook) ValidateUpdate(ctx context.Context | |
| !reflect.DeepEqual(newTyped.Spec.Template.Spec, oldTyped.Spec.Template.Spec) { | ||
| allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "template", "spec"), newTyped, machineTemplateImmutableMsg)) | ||
| } | ||
|
|
||
| templateErrs := validateVSphereVMNamingTemplate(ctx, newTyped) | ||
| if len(templateErrs) > 0 { | ||
| allErrs = append(allErrs, templateErrs...) | ||
| } | ||
| 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 { | ||
|
There was a problem hiding this comment. is this following some code that core CAPI already has or is this done from scratch as a use case for CAPV? There was a problem hiding this comment. 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. There was a problem hiding this comment. looks like a lot comes from that PR. There was a problem hiding this comment. I can do that if we prefer that. I just to wanted to call it what it is being used for. There was a problem hiding this comment. that would be my preference. not sure what other reviewers will comment on this. |
||
| var allErrs field.ErrorList | ||
| namingStrategy := vsphereMachineTemplate.Spec.Template.Spec.NamingStrategy | ||
| if namingStrategy != nil && namingStrategy.Template != nil { | ||
| name, err := services.GenerateVSphereVMName("machine", namingStrategy) | ||
| templateFldPath := field.NewPath("spec", "template", "spec", "namingStrategy", "template") | ||
| if err != nil { | ||
| allErrs = append(allErrs, | ||
| field.Invalid( | ||
| templateFldPath, | ||
| *namingStrategy.Template, | ||
| fmt.Sprintf("invalid VSphereVM name template: %v", err), | ||
| ), | ||
| ) | ||
| } else { | ||
| // Note: This validates that the resulting name is a valid Kubernetes object name. | ||
| for _, err := range validation.IsDNS1123Subdomain(name) { | ||
| allErrs = append(allErrs, | ||
| field.Invalid( | ||
| templateFldPath, | ||
| *namingStrategy.Template, | ||
| fmt.Sprintf("invalid VSphereVM name template, generated name is not a valid Kubernetes object name: %v", err), | ||
| ), | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| return allErrs | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
calculating -> preparing
as it's not a math calculation.
EDIT: seems consistent with the supervisor PR. so you can leave it as is.
this field is inside VSphereMachineSpec not VSphereVMSpec