Generate descriptions

Signed-off-by: ekarlso <endre.karlson@gmail.com>
ionos-cloud · Oct 9, 2024 · cba6b50 · cba6b50
1 parent 5299af1
commit cba6b50
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 19 deletions.
diff --git a/api/v1alpha1/proxmoxmachine_types.go b/api/v1alpha1/proxmoxmachine_types.go
@@ -50,6 +50,7 @@ const (
 	IPV6Format = "v6"
 )
 
+// ProxmoxMachineChecks defines possibibles checks to skip.
 type ProxmoxMachineChecks struct {
 	// Skip checking CloudInit which can be very useful for specific Operating Systems like TalOS
 	// +optional

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxclusters.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxclusters.yaml
@@ -79,6 +79,9 @@ spec:
                                 useful for specific Operating Systems like TalOS
                               type: boolean
                             skipQemuGuestAgent:
+                              description: Skip checking QEMU Agent readiness which
+                                can be very useful for specific Operating Systems
+                                like TalOS
                               type: boolean
                           type: object
                         description:

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxclustertemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxclustertemplates.yaml
@@ -98,6 +98,9 @@ spec:
                                         like TalOS
                                       type: boolean
                                     skipQemuGuestAgent:
+                                      description: Skip checking QEMU Agent readiness
+                                        which can be very useful for specific Operating
+                                        Systems like TalOS
                                       type: boolean
                                   type: object
                                 description:

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxmachines.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxmachines.yaml
@@ -72,6 +72,8 @@ spec:
                       for specific Operating Systems like TalOS
                     type: boolean
                   skipQemuGuestAgent:
+                    description: Skip checking QEMU Agent readiness which can be very
+                      useful for specific Operating Systems like TalOS
                     type: boolean
                 type: object
               description:

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxmachinetemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_proxmoxmachinetemplates.yaml
@@ -79,6 +79,9 @@ spec:
                               useful for specific Operating Systems like TalOS
                             type: boolean
                           skipQemuGuestAgent:
+                            description: Skip checking QEMU Agent readiness which
+                              can be very useful for specific Operating Systems like
+                              TalOS
                             type: boolean
                         type: object
                       description:

diff --git a/internal/service/vmservice/vm.go b/internal/service/vmservice/vm.go
@@ -108,35 +108,19 @@ func ReconcileVM(ctx context.Context, scope *scope.MachineScope) (infrav1alpha1.
 	return vm, nil
 }
 
-func skipQemuGuestCheck(mc *scope.MachineScope) bool {
-	if mc.ProxmoxMachine.Spec.Checks != nil {
-		return ptr.Deref(mc.ProxmoxMachine.Spec.Checks.SkipQemuGuestAgent, false)
-	}
-
-	return false
-}
-
-func skipCloudInitCheck(mc *scope.MachineScope) bool {
-	if mc.ProxmoxMachine.Spec.Checks != nil {
-		return ptr.Deref(mc.ProxmoxMachine.Spec.Checks.SkipCloudInitStatus, false)
-	}
-
-	return false
-}
-
 func checkCloudInitStatus(ctx context.Context, machineScope *scope.MachineScope) (requeue bool, err error) {
 	if !machineScope.VirtualMachine.IsRunning() {
 		// skip if the vm is not running.
 		return true, nil
 	}
 
-	if !skipQemuGuestCheck(machineScope) {
+	if !machineScope.SkipQemuGuestCheck() {
 		if err := machineScope.InfraCluster.ProxmoxClient.QemuAgentStatus(ctx, machineScope.VirtualMachine); err != nil {
 			return true, errors.Wrap(err, "error waiting for agent")
 		}
 	}
 
-	if !skipCloudInitCheck(machineScope) {
+	if !machineScope.SkipQemuGuestCheck() && !machineScope.SkipCloudInitCheck() {
 		if running, err := machineScope.InfraCluster.ProxmoxClient.CloudInitStatus(ctx, machineScope.VirtualMachine); err != nil || running {
 			if running {
 				return true, nil

diff --git a/internal/service/vmservice/vm_test.go b/internal/service/vmservice/vm_test.go
@@ -62,7 +62,7 @@ func TestReconcileVM_QemuAgentCheckDisabled(t *testing.T) {
 	}
 
 	proxmoxClient.EXPECT().GetVM(context.Background(), "node1", int64(123)).Return(vm, nil).Once()
-	proxmoxClient.EXPECT().CloudInitStatus(context.Background(), vm).Return(false, nil).Once()
+	// proxmoxClient.EXPECT().CloudInitStatus(context.Background(), vm).Return(false, nil).Once()
 
 	result, err := ReconcileVM(context.Background(), machineScope)
 	require.NoError(t, err)

diff --git a/pkg/proxmox/goproxmox/api_client.go b/pkg/proxmox/goproxmox/api_client.go
@@ -301,6 +301,7 @@ func (c *APIClient) CloudInitStatus(ctx context.Context, vm *proxmox.VirtualMach
 	return false, nil
 }
 
+// QemuAgentStatus returns the qemu-agent status of the VM.
 func (c *APIClient) QemuAgentStatus(ctx context.Context, vm *proxmox.VirtualMachine) error {
 	if err := vm.WaitForAgent(ctx, 5); err != nil {
 		return errors.Wrap(err, "error waiting for agent")

diff --git a/pkg/scope/machine.go b/pkg/scope/machine.go
@@ -243,3 +243,21 @@ func (m *MachineScope) GetBootstrapSecret(ctx context.Context, secret *corev1.Se
 
 	return m.client.Get(ctx, secretKey, secret)
 }
+
+// SkipQemuGuestCheck check whether qemu-agent status check is enabled.
+func (m *MachineScope) SkipQemuGuestCheck() bool {
+	if m.ProxmoxMachine.Spec.Checks != nil {
+		return ptr.Deref(m.ProxmoxMachine.Spec.Checks.SkipQemuGuestAgent, false)
+	}
+
+	return false
+}
+
+// SkipCloudInitCheck check whether cloud-init status check is enabled.
+func (m *MachineScope) SkipCloudInitCheck() bool {
+	if m.ProxmoxMachine.Spec.Checks != nil {
+		return ptr.Deref(m.ProxmoxMachine.Spec.Checks.SkipCloudInitStatus, false)
+	}
+
+	return false
+}