Make CPU and RAM configurable (#62)

* Make CPU cores, sockets and RAM configurable

* Update template

* Introduce constants for VM config options

* ⚠️ Change integer types to int32

* Invert and document bool return value meanings

---------

Co-authored-by: Mohamed Chiheb Ben Jemaa <mc.benjemaa@gmail.com>

Author: avorima

api/v1alpha1/proxmoxmachine_types.go

@@ -50,6 +50,24 @@ type ProxmoxMachineSpec struct {
 	// +optional
 	VirtualMachineID *int64 `json:"virtualMachineID,omitempty"`
 
+	// NumSockets is the number of CPU sockets in a virtual machine.
+	// Defaults to the property value in the template from which the virtual machine is cloned.
+	// +kubebuilder:validation:Minimum=1
+	// +optional
+	NumSockets int32 `json:"numSockets,omitempty"`
+
+	// NumCores is the number of cores per CPU socket in a virtual machine.
+	// Defaults to the property value in the template from which the virtual machine is cloned.
+	// +kubebuilder:validation:Minimum=1
+	// +optional
+	NumCores int32 `json:"numCores,omitempty"`
+
+	// MemoryMiB is the size of a virtual machine's memory, in MiB.
+	// Defaults to the property value in the template from which the virtual machine is cloned.
+	// +kubebuilder:validation:MultipleOf=8
+	// +optional
+	MemoryMiB int32 `json:"memoryMiB,omitempty"`
+
 	// Disks contains a set of disk configuration options,
 	// which will be applied before the first startup.
 	//
@@ -84,7 +102,7 @@ type DiskSize struct {
 	// template.
 	//
 	// +kubebuilder:validation:Minimum=5
-	SizeGB int `json:"sizeGb"`
+	SizeGB int32 `json:"sizeGb"`
 }
 
 // TargetFileStorageFormat the target format of the cloned disk.
@@ -117,7 +135,7 @@ type VirtualMachineCloneSpec struct {
 
 	// TemplateID the vm_template vmid used for cloning a new VM.
 	// +optional
-	TemplateID *int `json:"templateID,omitempty"`
+	TemplateID *int32 `json:"templateID,omitempty"`
 
 	// Description for the new VM.
 	// +optional
@@ -285,7 +303,7 @@ func (r *ProxmoxMachine) GetVirtualMachineID() int64 {
 }
 
 // GetTemplateID get the proxmox template "vmid" used to provision this machine.
-func (r *ProxmoxMachine) GetTemplateID() int {
+func (r *ProxmoxMachine) GetTemplateID() int32 {
 	if r.Spec.TemplateID != nil {
 		return *r.Spec.TemplateID
 	}

api/v1alpha1/zz_generated.deepcopy.go

@@ -81,6 +81,7 @@ spec:
                         description: "Size defines the size in gigabyte. \n As Proxmox
                           does not support shrinking, the size must be bigger than
                           the already configured size in the template."
+                        format: int32
                         minimum: 5
                         type: integer
                     required:
@@ -104,6 +105,27 @@ spec:
                 description: Full Create a full copy of all disks. This is always
                   done when you clone a normal VM. Create a Full clone by default.
                 type: boolean
+              memoryMiB:
+                description: MemoryMiB is the size of a virtual machine's memory,
+                  in MiB. Defaults to the property value in the template from which
+                  the virtual machine is cloned.
+                format: int32
+                multipleOf: 8
+                type: integer
+              numCores:
+                description: NumCores is the number of cores per CPU socket in a virtual
+                  machine. Defaults to the property value in the template from which
+                  the virtual machine is cloned.
+                format: int32
+                minimum: 1
+                type: integer
+              numSockets:
+                description: NumSockets is the number of CPU sockets in a virtual
+                  machine. Defaults to the property value in the template from which
+                  the virtual machine is cloned.
+                format: int32
+                minimum: 1
+                type: integer
               pool:
                 description: Pool Add the new VM to the specified pool.
                 type: string
@@ -135,6 +157,7 @@ spec:
               templateID:
                 description: TemplateID the vm_template vmid used for cloning a new
                   VM.
+                format: int32
                 type: integer
               virtualMachineID:
                 description: VirtualMachineID is the Proxmox identifier for the ProxmoxMachine

config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxmachines.yaml

@@ -86,6 +86,7 @@ spec:
                                   As Proxmox does not support shrinking, the size
                                   must be bigger than the already configured size
                                   in the template."
+                                format: int32
                                 minimum: 5
                                 type: integer
                             required:
@@ -111,6 +112,27 @@ spec:
                           always done when you clone a normal VM. Create a Full clone
                           by default.
                         type: boolean
+                      memoryMiB:
+                        description: MemoryMiB is the size of a virtual machine's
+                          memory, in MiB. Defaults to the property value in the template
+                          from which the virtual machine is cloned.
+                        format: int32
+                        multipleOf: 8
+                        type: integer
+                      numCores:
+                        description: NumCores is the number of cores per CPU socket
+                          in a virtual machine. Defaults to the property value in
+                          the template from which the virtual machine is cloned.
+                        format: int32
+                        minimum: 1
+                        type: integer
+                      numSockets:
+                        description: NumSockets is the number of CPU sockets in a
+                          virtual machine. Defaults to the property value in the template
+                          from which the virtual machine is cloned.
+                        format: int32
+                        minimum: 1
+                        type: integer
                       pool:
                         description: Pool Add the new VM to the specified pool.
                         type: string
@@ -143,6 +165,7 @@ spec:
                       templateID:
                         description: TemplateID the vm_template vmid used for cloning
                           a new VM.
+                        format: int32
                         type: integer
                       virtualMachineID:
                         description: VirtualMachineID is the Proxmox identifier for

config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxmachinetemplates.yaml

@@ -12,3 +12,6 @@ export DNS_SERVERS="[8.8.8.8,8.8.4.4]"
 export ALLOWED_NODES="[pve1,pve2,pve3]"
 export BOOT_VOLUME_DEVICE=scsi0
 export BOOT_VOLUME_SIZE=100
+export NUM_SOCKETS=2
+export NUM_CORES=4
+export MEMORY_MIB=16384

envfile.example

@@ -16,16 +16,16 @@ import (
 	"github.com/ionos-cloud/cluster-api-provider-proxmox/pkg/scope"
 )
 
-func reconcileBootstrapData(ctx context.Context, machineScope *scope.MachineScope) (bool, error) {
+func reconcileBootstrapData(ctx context.Context, machineScope *scope.MachineScope) (requeue bool, err error) {
 	if pointer.BoolDeref(machineScope.ProxmoxMachine.Status.BootstrapDataProvided, false) {
 		// skip machine already have the bootstrap data.
-		return true, nil
+		return false, nil
 	}
 
 	if machineScope.ProxmoxMachine.Status.IPAddr == nil {
 		// skip machine doesn't have an IpAddress yet.
 		conditions.MarkFalse(machineScope.ProxmoxMachine, infrav1alpha1.VMProvisionedCondition, infrav1alpha1.WaitingForStaticIPAllocationReason, clusterv1.ConditionSeverityWarning, "no ip address")
-		return false, nil
+		return true, nil
 	}
 	machineScope.Logger.V(4).Info("reconciling BootstrapData.")
 
@@ -66,7 +66,7 @@ func reconcileBootstrapData(ctx context.Context, machineScope *scope.MachineScop
 
 	machineScope.ProxmoxMachine.Status.BootstrapDataProvided = pointer.Bool(true)
 
-	return true, nil
+	return false, nil
 }
 
 // getBootstrapData obtains a machine's bootstrap data from the relevant k8s secret and returns the

internal/service/vmservice/bootstrap.go

@@ -35,6 +35,15 @@ import (
 	"github.com/ionos-cloud/cluster-api-provider-proxmox/pkg/scope"
 )
 
+const (
+	// See following link for a list of available config options:
+	// https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/config
+
+	optionSockets = "sockets"
+	optionCores   = "cores"
+	optionMemory  = "memory"
+)
+
 // ReconcileVM makes sure that the VM is in the desired state by:
 //  1. Creating the VM if it does not exist, then...
 //  2. Updating the VM with the bootstrap data, such as the cloud-init meta and user data, before...
@@ -98,19 +107,23 @@ func ReconcileVM(ctx context.Context, scope *scope.MachineScope) (infrav1alpha1.
 		return vm, err
 	}
 
-	if ok, err := reconcileIPAddresses(ctx, scope); err != nil || !ok {
+	if requeue, err := reconcileIPAddresses(ctx, scope); err != nil || requeue {
 		return vm, err
 	}
 
-	if ok, err := reconcileBootstrapData(ctx, scope); err != nil || !ok {
+	if requeue, err := reconcileBootstrapData(ctx, scope); err != nil || requeue {
 		return vm, err
 	}
 
 	if err := reconcileDisks(scope); err != nil {
 		return vm, err
 	}
 
-	if ok, err := reconcilePowerState(scope); err != nil || !ok {
+	if requeue, err := reconcileVirtualMachineConfig(scope); err != nil || requeue {
+		return vm, err
+	}
+
+	if requeue, err := reconcilePowerState(scope); err != nil || requeue {
 		return vm, err
 	}
 
@@ -145,14 +158,47 @@ func reconcileDisks(machineScope *scope.MachineScope) error {
 	return nil
 }
 
-func reconcilePowerState(machineScope *scope.MachineScope) (bool, error) {
+func reconcileVirtualMachineConfig(machineScope *scope.MachineScope) (requeue bool, err error) {
+	if machineScope.VirtualMachine.IsRunning() || machineScope.ProxmoxMachine.Status.Ready {
+		// We only want to do this before the machine was started or is ready
+		return false, nil
+	}
+
+	vmConfig := machineScope.VirtualMachine.VirtualMachineConfig
+
+	var vmOptions []proxmox.VirtualMachineOption
+	if value := machineScope.ProxmoxMachine.Spec.NumSockets; value > 0 && vmConfig.Sockets != int(value) {
+		vmOptions = append(vmOptions, proxmox.VirtualMachineOption{Name: optionSockets, Value: value})
+	}
+	if value := machineScope.ProxmoxMachine.Spec.NumCores; value > 0 && vmConfig.Cores != int(value) {
+		vmOptions = append(vmOptions, proxmox.VirtualMachineOption{Name: optionCores, Value: value})
+	}
+	if value := machineScope.ProxmoxMachine.Spec.MemoryMiB; value > 0 && vmConfig.Memory != int(value) {
+		vmOptions = append(vmOptions, proxmox.VirtualMachineOption{Name: optionMemory, Value: value})
+	}
+	if len(vmOptions) == 0 {
+		return false, nil
+	}
+
+	machineScope.V(4).Info("reconciling virtual machine config")
+
+	task, err := machineScope.InfraCluster.ProxmoxClient.ConfigureVM(machineScope.VirtualMachine, vmOptions...)
+	if err != nil {
+		return false, errors.Wrapf(err, "failed to configure VM %s", machineScope.Name())
+	}
+
+	machineScope.ProxmoxMachine.Status.TaskRef = pointer.String(string(task.UPID))
+	return true, nil
+}
+
+func reconcilePowerState(machineScope *scope.MachineScope) (requeue bool, err error) {
 	ipAddr := machineScope.ProxmoxMachine.Status.IPAddr
 
 	if ipAddr == nil || *ipAddr == "" {
 		machineScope.V(4).Info("ip address not set for machine")
 		// machine doesn't have an ip address yet
 		// needs to reconcile again
-		return false, nil
+		return true, nil
 	}
 
 	machineScope.V(4).Info("ensuring machine is started")
@@ -166,10 +212,10 @@ func reconcilePowerState(machineScope *scope.MachineScope) (bool, error) {
 
 	if t != nil {
 		machineScope.ProxmoxMachine.Status.TaskRef = pointer.String(string(t.UPID))
-		return false, nil
+		return true, nil
 	}
 
-	return true, nil
+	return false, nil
 }
 
 //nolint:unparam
@@ -180,10 +226,10 @@ func reconcileNetworkStatus(machineScope *scope.MachineScope) error {
 	return nil
 }
 
-func reconcileIPAddresses(ctx context.Context, machineScope *scope.MachineScope) (bool, error) {
+func reconcileIPAddresses(ctx context.Context, machineScope *scope.MachineScope) (requeue bool, err error) {
 	if machineScope.ProxmoxMachine.Status.IPAddr != nil {
 		// skip machine has an IpAddress already.
-		return true, nil
+		return false, nil
 	}
 	machineScope.Logger.V(4).Info("reconciling IPAddresses.")
 	conditions.MarkFalse(machineScope.ProxmoxMachine, infrav1alpha1.VMProvisionedCondition, infrav1alpha1.WaitingForStaticIPAllocationReason, clusterv1.ConditionSeverityInfo, "")
@@ -197,7 +243,7 @@ func reconcileIPAddresses(ctx context.Context, machineScope *scope.MachineScope)
 			if err != nil {
 				return false, errors.Wrapf(err, "unable to create Ip address claim for machine %s", machineScope.Name())
 			}
-			return false, nil
+			return true, nil
 		}
 	}
 
@@ -214,17 +260,17 @@ func reconcileIPAddresses(ctx context.Context, machineScope *scope.MachineScope)
 		machineScope.Logger.V(4).Info("adding virtual machine ip tag.")
 		t, err := machineScope.VirtualMachine.AddTag(ipTag)
 		if err != nil {
-			return false, errors.Wrapf(err, "unable to add Ip tag to VirtualMachine %s", machineScope.VirtualMachine.Name)
+			return false, errors.Wrapf(err, "unable to add Ip tag to VirtualMachine %s", machineScope.Name())
 		}
 		machineScope.ProxmoxMachine.Status.TaskRef = pointer.String(string(t.UPID))
-		return false, nil
+		return true, nil
 	}
 
 	// update the status.IpAddr.
 	machineScope.Logger.V(4).Info("updating ProxmoxMachine.status.ipAddr.")
 	machineScope.ProxmoxMachine.Status.IPAddr = pointer.String(ip)
 
-	return true, nil
+	return false, nil
 }
 
 func reconcileMachineAddresses(scope *scope.MachineScope) error {
@@ -303,8 +349,8 @@ func createVM(scope *scope.MachineScope) (proxmox.VMCloneResponse, error) {
 		options.Target = selectNextNode(scope)
 	}
 
-	templateID := *scope.ProxmoxMachine.Spec.TemplateID
-	res, err := scope.InfraCluster.ProxmoxClient.CloneVM(templateID, options)
+	templateID := scope.ProxmoxMachine.GetTemplateID()
+	res, err := scope.InfraCluster.ProxmoxClient.CloneVM(int(templateID), options)
 	if err != nil {
 		return res, err
 	}

internal/service/vmservice/vm.go

@@ -23,6 +23,8 @@ import "github.com/luthermonson/go-proxmox"
 type Client interface {
 	CloneVM(vmID int, clone VMCloneRequest) (VMCloneResponse, error)
 
+	ConfigureVM(vm *proxmox.VirtualMachine, options ...VirtualMachineOption) (*proxmox.Task, error)
+
 	GetVM(nodeName string, vmID int64) (*proxmox.VirtualMachine, error)
 
 	DeleteVM(nodeName string, vmID int64) (*proxmox.Task, error)

pkg/proxmox/client.go

@@ -65,6 +65,15 @@ func (c *ProxmoxAPIClient) CloneVM(vmID int, clone capmox.VMCloneRequest) (capmo
 	return capmox.VMCloneResponse{NewID: int64(newID), Task: task}, nil
 }
 
+// ConfigureVM updates a VMs settings.
+func (c *ProxmoxAPIClient) ConfigureVM(vm *proxmox.VirtualMachine, options ...capmox.VirtualMachineOption) (*proxmox.Task, error) {
+	task, err := vm.Config(options...)
+	if err != nil {
+		return nil, fmt.Errorf("unable to configure vm: %w", err)
+	}
+	return task, nil
+}
+
 // GetVM returns a VM based on nodeName and vmID.
 func (c *ProxmoxAPIClient) GetVM(nodeName string, vmID int64) (*proxmox.VirtualMachine, error) {
 	node, err := c.Client.Node(nodeName)

pkg/proxmox/goproxmox/api_client.go

@@ -21,3 +21,6 @@ type VMCloneResponse struct {
 	NewID int64         `json:"newId,omitempty"`
 	Task  *proxmox.Task `json:"task,omitempty"`
 }
+
+// VirtualMachineOption is an alias for VirtualMachineOption to prevent import conflicts.
+type VirtualMachineOption = proxmox.VirtualMachineOption