Add operating system and architecture information to VSphereMachineTemplate status

Author: zhouke1991

apis/vmware/v1beta1/conversion.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1beta1
 
 import (
+	apimachineryconversion "k8s.io/apimachinery/pkg/conversion"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
 	vmwarev1 "sigs.k8s.io/cluster-api-provider-vsphere/apis/vmware/v1beta2"
@@ -111,3 +112,12 @@ func (dst *ProviderServiceAccount) ConvertFrom(srcRaw conversion.Hub) error {
 
 	return nil
 }
+
+// Convert_v1beta2_VSphereMachineTemplateStatus_To_v1beta1_VSphereMachineTemplateStatus converts v1beta2 VSphereMachineTemplateStatus to v1beta1.
+// This is a manual conversion function that handles the NodeInfo field which doesn't exist in v1beta1.
+// The NodeInfo field is intentionally dropped during this conversion as v1beta1 doesn't support it.
+func Convert_v1beta2_VSphereMachineTemplateStatus_To_v1beta1_VSphereMachineTemplateStatus(in *vmwarev1.VSphereMachineTemplateStatus, out *VSphereMachineTemplateStatus, s apimachineryconversion.Scope) error {
+	// Call the auto-generated conversion function which handles the Capacity field
+	// Note: The NodeInfo field from v1beta2 is intentionally dropped as it doesn't exist in v1beta1
+	return autoConvert_v1beta2_VSphereMachineTemplateStatus_To_v1beta1_VSphereMachineTemplateStatus(in, out, s)
+}

apis/vmware/v1beta1/conversion_test.go

@@ -24,6 +24,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	runtimeserializer "k8s.io/apimachinery/pkg/runtime/serializer"
 	utilconversion "sigs.k8s.io/cluster-api/util/conversion"
+	"sigs.k8s.io/randfill"
 
 	vmwarev1 "sigs.k8s.io/cluster-api-provider-vsphere/apis/vmware/v1beta2"
 )
@@ -91,7 +92,16 @@ func VSphereMachineFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {
 }
 
 func VSphereMachineTemplateFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {
-	return []interface{}{}
+	return []interface{}{
+		hubVSphereMachineTemplateStatus,
+	}
+}
+
+func hubVSphereMachineTemplateStatus(in *vmwarev1.VSphereMachineTemplate, c randfill.Continue) {
+	c.FillNoCustom(in)
+	// NodeInfo doesn't exist in v1beta1, so it will be lost during hub-spoke-hub conversion.
+	// Clear it in the hub object before comparison.
+	in.Status.NodeInfo = vmwarev1.NodeInfo{}
 }
 
 func ProviderServiceAccountFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {

apis/vmware/v1beta1/zz_generated.conversion.go

@@ -30,6 +30,45 @@ const (
 	VSphereResourceMemory corev1.ResourceName = "memory"
 )
 
+// Architecture represents the CPU architecture of the node.
+// Its underlying type is a string and its value can be any of amd64, arm64, s390x, ppc64le.
+// +kubebuilder:validation:Enum=amd64;arm64;s390x;ppc64le
+// +enum
+type Architecture string
+
+const (
+	// ArchitectureAmd64 is the AMD64 architecture.
+	ArchitectureAmd64 Architecture = "amd64"
+	// ArchitectureArm64 is the ARM64 architecture.
+	ArchitectureArm64 Architecture = "arm64"
+	// ArchitectureS390x is the S390X architecture.
+	ArchitectureS390x Architecture = "s390x"
+	// ArchitecturePpc64le is the PPC64LE architecture.
+	ArchitecturePpc64le Architecture = "ppc64le"
+)
+
+const (
+	// VMwareSystemOSArchPropertyKey is the key for the architecture property in the
+	// ClusterVirtualMachineImage's vmwareSystemProperties. This is defined by VM Operator.
+	VMwareSystemOSArchPropertyKey = "vmware-system.tkr.os-arch"
+	// VMwareSystemOSTypePropertyKey is the key for the operating system type property in the
+	// ClusterVirtualMachineImage's vmwareSystemProperties. This is defined by VM Operator.
+	VMwareSystemOSTypePropertyKey = "vmware-system.tkr.os-type"
+)
+
+// OperatingSystem represents the operating system of the node.
+// Its underlying type is a string and its value can be any of linux, windows.
+// +kubebuilder:validation:Enum=linux;windows
+// +enum
+type OperatingSystem string
+
+const (
+	// OperatingSystemLinux is the Linux operating system.
+	OperatingSystemLinux OperatingSystem = "linux"
+	// OperatingSystemWindows is the Windows operating system.
+	OperatingSystemWindows OperatingSystem = "windows"
+)
+
 // VSphereMachineTemplateSpec defines the desired state of VSphereMachineTemplate.
 type VSphereMachineTemplateSpec struct {
 	// template defines the desired state of VSphereMachineTemplate.
@@ -43,6 +82,11 @@ type VSphereMachineTemplateStatus struct {
 	// https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20210310-opt-in-autoscaling-from-zero.md
 	// +optional
 	Capacity corev1.ResourceList `json:"capacity,omitempty"`
+	// nodeInfo defines the node's architecture and operating system.
+	// This value is used for autoscaling from zero operations as defined in:
+	// https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20210310-opt-in-autoscaling-from-zero.md#implementation-detailsnotesconstraints
+	// +optional
+	NodeInfo NodeInfo `json:"nodeInfo,omitempty,omitzero"`
 }
 
 // +kubebuilder:object:root=true
@@ -65,6 +109,19 @@ type VSphereMachineTemplate struct {
 	Status VSphereMachineTemplateStatus `json:"status,omitempty"`
 }
 
+// NodeInfo contains information about the node's architecture and operating system.
+// +kubebuilder:validation:MinProperties=1
+type NodeInfo struct {
+	// architecture is the CPU architecture of the node.
+	// Its underlying type is a string and its value can be any of amd64, arm64, s390x, ppc64le.
+	// +optional
+	Architecture Architecture `json:"architecture,omitempty"`
+	// operatingSystem is a string representing the operating system of the node.
+	// This may be a string like 'linux' or 'windows'.
+	// +optional
+	OperatingSystem OperatingSystem `json:"operatingSystem,omitempty"`
+}
+
 // +kubebuilder:object:root=true
 
 // VSphereMachineTemplateList contains a list of VSphereMachineTemplate.

apis/vmware/v1beta2/vspheremachinetemplate_types.go

@@ -241,6 +241,7 @@ rules:
 - apiGroups:
   - vmoperator.vmware.com
   resources:
+  - clustervirtualmachineimages
   - virtualmachineclasses
   verbs:
   - get

apis/vmware/v1beta2/zz_generated.deepcopy.go

@@ -745,6 +745,32 @@ spec:
                   This value is used for autoscaling from zero operations as defined in:
                   https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20210310-opt-in-autoscaling-from-zero.md
                 type: object
+              nodeInfo:
+                description: |-
+                  nodeInfo defines the node's architecture and operating system.
+                  This value is used for autoscaling from zero operations as defined in:
+                  https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20210310-opt-in-autoscaling-from-zero.md#implementation-detailsnotesconstraints
+                minProperties: 1
+                properties:
+                  architecture:
+                    description: |-
+                      architecture is the CPU architecture of the node.
+                      Its underlying type is a string and its value can be any of amd64, arm64, s390x, ppc64le.
+                    enum:
+                    - amd64
+                    - arm64
+                    - s390x
+                    - ppc64le
+                    type: string
+                  operatingSystem:
+                    description: |-
+                      operatingSystem is a string representing the operating system of the node.
+                      This may be a string like 'linux' or 'windows'.
+                    enum:
+                    - linux
+                    - windows
+                    type: string
+                type: object
             type: object
         type: object
     served: true

config/rbac/role.yaml

@@ -18,6 +18,7 @@ package vmware
 
 import (
 	"context"
+	"fmt"
 
 	"github.com/pkg/errors"
 	corev1 "k8s.io/api/core/v1"
@@ -41,6 +42,7 @@ import (
 // +kubebuilder:rbac:groups=vmware.infrastructure.cluster.x-k8s.io,resources=vspheremachinetemplates,verbs=get;list;watch;create;update;patch;delete
 // +kubebuilder:rbac:groups=vmware.infrastructure.cluster.x-k8s.io,resources=vspheremachinetemplates/status,verbs=get;update;patch
 // +kubebuilder:rbac:groups=vmoperator.vmware.com,resources=virtualmachineclasses,verbs=get;list;watch
+// +kubebuilder:rbac:groups=vmoperator.vmware.com,resources=clustervirtualmachineimages,verbs=get;list;watch
 
 // AddVSphereMachineTemplateControllerToManager adds the machine template controller to the provided
 // manager.
@@ -107,9 +109,79 @@ func (r *vSphereMachineTemplateReconciler) Reconcile(ctx context.Context, req ct
 		vSphereMachineTemplate.Status.Capacity[vmwarev1.VSphereResourceMemory] = vmClass.Spec.Hardware.Memory
 	}
 
+	// retrieve the os and arch info from the ClusterVirtualMachineImage
+	os, arch := getOSAndArchFromClusterVirtualMachineImage(ctx, r.Client, vSphereMachineTemplate.Spec.Template.Spec.ImageName)
+
+	if validOS := normalizeOperatingSystem(os); validOS != "" {
+		vSphereMachineTemplate.Status.NodeInfo.OperatingSystem = validOS
+	}
+	if validArch := normalizeArchitecture(arch); validArch != "" {
+		vSphereMachineTemplate.Status.NodeInfo.Architecture = validArch
+	}
+	fmt.Println("vSphereMachineTemplate.Status.NodeInfo.OperatingSystem", vSphereMachineTemplate.Status.NodeInfo.OperatingSystem)
+	fmt.Println("vSphereMachineTemplate.Status.NodeInfo.Architecture", vSphereMachineTemplate.Status.NodeInfo.Architecture)
+
 	return reconcile.Result{}, patchHelper.Patch(ctx, vSphereMachineTemplate)
 }
 
+// normalizeOperatingSystem converts the OS string from CVMI to a valid OperatingSystem constant.
+// Returns empty string if the value is not recognized.
+func normalizeOperatingSystem(os string) vmwarev1.OperatingSystem {
+	switch os {
+	case "linux":
+		return vmwarev1.OperatingSystemLinux
+	case "windows":
+		return vmwarev1.OperatingSystemWindows
+	default:
+		return ""
+	}
+}
+
+// normalizeArchitecture converts the architecture string from CVMI to a valid Architecture constant.
+// Returns empty string if the value is not recognized.
+func normalizeArchitecture(arch string) vmwarev1.Architecture {
+	switch arch {
+	case "amd64":
+		return vmwarev1.ArchitectureAmd64
+	case "arm64":
+		return vmwarev1.ArchitectureArm64
+	case "s390x":
+		return vmwarev1.ArchitectureS390x
+	case "ppc64le":
+		return vmwarev1.ArchitecturePpc64le
+	default:
+		return ""
+	}
+}
+
+func getOSAndArchFromClusterVirtualMachineImage(ctx context.Context, c client.Client, imageName string) (string, string) {
+	fmt.Println("run here", "11111")
+	if imageName == "" {
+		return "", ""
+	}
+	fmt.Println("run here", "2222")
+	// Try to fetch the ClusterVirtualMachineImage with the given name
+	cvmi := &vmoprvhub.ClusterVirtualMachineImage{}
+	if err := c.Get(ctx, client.ObjectKey{Name: imageName}, cvmi); err != nil {
+		fmt.Println("run here", "3333", "error:", err)
+		return "", ""
+	}
+
+	fmt.Println("cvmi.Status.VMwareSystemProperties", cvmi.Status.VMwareSystemProperties)
+	// Extract OS type and architecture from vmwareSystemProperties
+	var osType, osArch string
+	for _, prop := range cvmi.Status.VMwareSystemProperties {
+		switch prop.Key {
+		case vmwarev1.VMwareSystemOSTypePropertyKey:
+			osType = prop.Value
+		case vmwarev1.VMwareSystemOSArchPropertyKey:
+			osArch = prop.Value
+		}
+	}
+
+	return osType, osArch
+}
+
 // enqueueVirtualMachineClassToVSphereMachineTemplateRequests returns a list of VSphereMachineTemplate reconcile requests
 // that use a specific VirtualMachineClass.
 func (r *vSphereMachineTemplateReconciler) enqueueVirtualMachineClassToVSphereMachineTemplateRequests(ctx context.Context, virtualMachineClass client.Object) []reconcile.Request {